Description

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.

Properties

Notes

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.

Examples

To configure the check:

<module name="Checker">
  <module name="TreeWalker">
    <module name="TodoComment"/>
  </module>
</module>
        

Example:

public class Example1 {
  int i;
  int x;
  public void test() {
    i++;   // TODO: do differently in future    // violation
    i++;   // todo: do differently in future
    i=i/x; // FIXME: handle x = 0 case
    i=i/x; // FIX :  handle x = 0 case
  }
}
        

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:

public class Example2 {
  int i;
  int x;
  public void test() {
    i++;   // TODO: do differently in future    // violation
    i++;   // todo: do differently in future
    i=i/x; // FIXME: handle x = 0 case          // violation
    i=i/x; // FIX :  handle x = 0 case
  }
}
        

Example of Usage

• Sun Style
• Checkstyle Style

Violation Messages

• todo.match

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks

Parent Module

TreeWalker