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:".

    Parent is

    Violation Message Keys:

    • todo.match