|
Checks for Javadoc Types
This module is responsible for checking Javadoc comments
in a source file.
JavadocType
This mandates one or more properties for the Javadoc. Typically, you can specify
the following properties for the Javadoc comments.
- scope
- author format
- version format.
- version format.
For example,
<module name="JavadocType"> <property name="versionFormat"
value="\$Revision.*\$"/></module>
The above configuration will mandate a CVS revision tag to be
present in the Javadoc. Checks for naming convention, The
Checkstyle can enforce naming convention for the members,
constants, package etc.
For example,
<module name="ConstantName"> <property name="format" value="^c[A-Z][a-zA-Z0-9]*$"/> </module>
This configuration will enforce that constant names start with a
"c" in front of them.
Checks for block style
Checkstyle can enforce standards for writing blocks such as
loops, etc. It enforces standards for using curly brackets on the
same line or new line, checks for empty blocks and more.
LeftCurly
This checks for the position of the left curly braces for a
defined block such as class, if-else loops, for loops etc. For
example,
<module name="LeftCurly"> <property name="option"
value="nl"/> <property name="tokens" value="LITERAL_IF,
LITERAL_ELSE"/></module>
This configuration enforces that the
left curly braces are placed in a newline for the "if loop" and
"else loops".
New on the Java Boutique:
New Review:
Time Management Made Easy with the Quartz Enterprise Job Scheduler
Why not just use the Java timer API? This open source scheduling
API boasts simplicity, ease-of-integration, a well-rounded feature
set, and it's free!
New Applet:
Reverse Complement
Reverse Complement is a simple applet that converts DNA or RNA
sequences into three useful formats.
Elsewhere on internet.com:
WebDeveloper Java
Lots of Java information on webdeveloper.com
WDVL Java
Thorough Java resource at the Web Developer's Virtual Library.
ScriptSearch Java
Hundreds of free Java code files to download.
jGuru: Your View of the Java Universe
Customizable portal with online training, FAQs, regular news updates, and tutorials.
|