Re: Check for @param sentence format
Roman Ivanov <[email protected]> Sun, 25 Aug 2013 18:04:05 -0700
| Newsgroups | gmane.comp.java.audit.checkstyle.user |
|---|---|
| Message-ID | <[email protected]> |
--===============1169937628322503419==
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body smarttemplateinserted="true" text="#000000" bgcolor="#FFFFFF">
<div id="smartTemplate4-quoteHeader">
<div style="font-family:Verdana; font-size:14px">
<font style="font-size:14px" face="Verdana">Hello Tom,
<br>
<br>
Please take a look at <br>
<a class="moz-txt-link-freetext" href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html">http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html</a><br>
<br>
</font>from that page:<br>
<font style="font-size:14px" face="Verdana">At Oracle, we have
developed a tool for checking doc comments, called the Oracle
Doc Check Doclet, or <a
href="http://www.oracle.com/technetwork/java/javase/documentation/ssLINK/141437">DocCheck</a>.
You run it on source code and it generates a report describing
what style and tag errors the comments have, and recommends
changes. We have tried to make its rules conform to the rules
in this document.<br>
<br>
Thanks,<br>
Roman Ivanov.</font> <br>
<hr>
<div><b>From:</b> Roman Ivanov <a class="moz-txt-link-rfc2396E" href="mailto:[email protected]"><[email protected]></a></div>
<div><b>Sent:</b> Sunday, August 25, 2013 5:48PM</div>
<div><b>To:</b> <a class="moz-txt-link-abbreviated" href="mailto:[email protected]">[email protected]</a></div>
<div><b>CC:</b> </div>
<div><b>Subject:</b> Re: [Checkstyle-user] Check for @param
sentence format</div>
</div>
<br>
</div>
<blockquote cite="mid:[email protected]" type="cite">
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
<div id="smartTemplate4-quoteHeader">
<div style="font-family:Verdana; font-size:14px">Hello Tony, <br>
<div id="smartTemplate4-template"><font style="font-size:14px"
face="Verdana"> <br>
There is no way in Checkstyle have access to JavaDoc
content, all comments are ignored.<br>
To examine to what tokens Checkstyle have access please
launch:<br>
java -classpath checkstyle-5.6-all.jar
com.puppycrawl.tools.checkstyle.gui.Main<br>
<br>
Workaround (if you need that feature badly):<br>
you can try to use RegularExpressionCheck - <a
moz-do-not-send="true" class="moz-txt-link-freetext"
href="http://checkstyle.sourceforge.net/config_regexp.html">http://checkstyle.sourceforge.net/config_regexp.html</a><br>
But do it with caution and proper testing, that could not
guaranty you 100% coverage of all cases but might help to
find most of cases.<br>
<br>
Thanks,<br>
Roman Ivanov.</font> <br>
</div>
<hr>
<div><b>From:</b> Tony HEDOUX <a moz-do-not-send="true"
class="moz-txt-link-rfc2396E"
href="mailto:[email protected]"><[email protected]></a></div>
<div><b>Sent:</b> Tuesday, August 20, 2013 7:44AM</div>
<div><b>To:</b> <a moz-do-not-send="true"
class="moz-txt-link-abbreviated"
href="mailto:[email protected]">[email protected]</a>
<a moz-do-not-send="true" class="moz-txt-link-rfc2396E"
href="mailto:[email protected]"><[email protected]></a></div>
<div><b>CC:</b> </div>
<div><b>Subject:</b> [Checkstyle-user] Check for @param
sentence format</div>
</div>
<br>
</div>
<blockquote cite="mid:[email protected]"
type="cite">
<style><!--
.hmmessage P
{
margin:0px;
padding:0px
}
body.hmmessage
{
font-size: 12pt;
font-family:Calibri
}
--></style>
<div dir="ltr">Hi,
<div><br>
</div>
<div>I'm looking for a way to check the format of java @param
comments.</div>
<div><br>
</div>
<div>For example, I want to ensure these comments begin with
an uppercase and do not finished with a point.</div>
<div><br>
</div>
<div>I can achieve this easily on Class parameter with the
WriteTag checker. But I can't find a way to do it works for
a method comments.</div>
<div><br>
</div>
<div>Any clue about this?</div>
<div><br>
</div>
<div>Thx for help,</div>
<div><br>
</div>
<div>Tony</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">------------------------------------------------------------------------------
Introducing Performance Central, a new site from SourceForge and
AppDynamics. Performance Central is your source for news, insights,
analysis and resources for efficient Application Performance Management.
Visit us today!
<a moz-do-not-send="true" class="moz-txt-link-freetext" href="http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk">http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk</a></pre>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
Checkstyle-user mailing list
<a moz-do-not-send="true" class="moz-txt-link-abbreviated" href="mailto:[email protected]">[email protected]</a>
<a moz-do-not-send="true" class="moz-txt-link-freetext" href="https://lists.sourceforge.net/lists/listinfo/checkstyle-user">https://lists.sourceforge.net/lists/listinfo/checkstyle-user</a>
</pre>
</blockquote>
<br>
<br>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">------------------------------------------------------------------------------
Introducing Performance Central, a new site from SourceForge and
AppDynamics. Performance Central is your source for news, insights,
analysis and resources for efficient Application Performance Management.
Visit us today!
<a class="moz-txt-link-freetext" href="http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk">http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk</a></pre>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
Checkstyle-user mailing list
<a class="moz-txt-link-abbreviated" href="mailto:[email protected]">[email protected]</a>
<a class="moz-txt-link-freetext" href="https://lists.sourceforge.net/lists/listinfo/checkstyle-user">https://lists.sourceforge.net/lists/listinfo/checkstyle-user</a>
</pre>
</blockquote>
<br>
<br>
<div id="smartTemplate4-template"><br>
</div>
</body>
</html>
--===============1169937628322503419==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
------------------------------------------------------------------------------
Introducing Performance Central, a new site from SourceForge and
AppDynamics. Performance Central is your source for news, insights,
analysis and resources for efficient Application Performance Management.
Visit us today!
http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk
--===============1169937628322503419==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
_______________________________________________
Checkstyle-user mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user
--===============1169937628322503419==--