Since Checkstyle 3.0
Checks for TODO:
comments. Actually
it is a generic
pattern matcher on Java comments. To check for other
patterns in Java comments, set the format
property.
name | description | type | default value | since |
---|---|---|---|---|
format | Specify pattern to match comments against. | Pattern | "TODO:" |
3.0 |
Using TODO:
comments is a great way
to keep track of tasks that need to be done. Having them
reported by Checkstyle makes it very hard to forget about
them.
To configure the check:
<module name="Checker"> <module name="TreeWalker"> <module name="TodoComment"/> </module> </module>
Example:
i++; // TODO: do differently in future // violation i++; // todo: do differently in future // OK
To configure the check for comments that contain TODO
and FIXME
:
<module name="Checker"> <module name="TreeWalker"> <module name="TodoComment"> <property name="format" value="(TODO)|(FIXME)"/> </module> </module> </module>
Example:
i++; // TODO: do differently in future // violation i++; // todo: do differently in future // OK i=i/x; // FIXME: handle x = 0 case // violation i=i/x; // FIX : handle x = 0 case // OK
All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.
com.puppycrawl.tools.checkstyle.checks