com.puppycrawl.tools.checkstyle.checks
public class TodoCommentCheck extends AbstractFormatCheck
A check for TODO comments. Actually it is a generic {@link java.util.regex.Pattern regular expression} matcher on Java comments. To check for other patterns in Java comments, set property format.
An example of how to configure the check is:
<module name="TodoComment"/>
An example of how to configure the check for comments that contain
WARNING
is:
<module name="TodoComment"> <property name="format" value="WARNING"/> </module>
Version: 1.0
Constructor Summary | |
---|---|
TodoCommentCheck()
Creates a new TodoCommentCheck instance. |
Method Summary | |
---|---|
void | beginTree(DetailAST aRootAST) {@inheritDoc} |
int[] | getDefaultTokens() {@inheritDoc} |
TodoCommentCheck
instance.