Class TodoCommentCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks for TODO:
comments. Actually it is a generic
regular expression matcher on Java comments. To check for other patterns
in Java comments, set the format
property.
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.
-
Property
format
- Specify pattern to match comments against. Type isjava.util.regex.Pattern
. Default value is"TODO:"
.
To configure the check:
<module name="TodoComment"/>
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="TodoComment"> <property name="format" value="(TODO)|(FIXME)"/> </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
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
todo.match
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.boolean
Whether comment nodes are required or not.void
Setter to specify pattern to match comments against.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
-
Constructor Details
-
TodoCommentCheck
public TodoCommentCheck()
-
-
Method Details
-
isCommentNodesRequired
public boolean isCommentNodesRequired()Description copied from class:AbstractCheck
Whether comment nodes are required or not.- Overrides:
isCommentNodesRequired
in classAbstractCheck
- Returns:
- false as a default value.
-
setFormat
Setter to specify pattern to match comments against.- Parameters:
pattern
- pattern of 'todo' comment.
-
getDefaultTokens
public int[] getDefaultTokens()Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
getAcceptableTokens
public int[] getAcceptableTokens()Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-