Package com.puppycrawl.tools.checkstyle.checks

Class TodoCommentCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class TodoCommentCheck
extends AbstractCheck

    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.

    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 is java.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