Perl::Critic::Policy::Bangs::ProhibitFlagComments

NAME

Perl::Critic::Policy::Bangs::ProhibitFlagComments − Don’t use XXX, TODO, or FIXME.

AFFILIATION

This Policy is part of the Perl::Critic::Bangs distribution.

DESCRIPTION

Programmers often leave comments intended to "flag" themselves to problems later. This policy looks for comments containing ’ XXX ’, ’ TODO ’, or ’ FIXME ’.

CONFIGURATION

By default, this policy only looks for ’ XXX ’, ’ TODO ’, or ’ FIXME ’ in comments. You can override this by specifying a value for "keywords" in your .perlcriticrc file like this:

  [Bangs::ProhibitFlagComments]
  keywords = XXX TODO FIXME BUG REVIEW

AUTHOR

Andrew Moore <amoore AT mooresystems DOT com>

ACKNOWLEDGMENTS

Adapted from policies by Jeffrey Ryan Thalhammer <thaljef AT cpan DOT org>, Based on App::Fluff by Andy Lester, "<andy at petdance.com>"

COPYRIGHT

Copyright (c) 2006−2011 Andy Lester <andy AT petdance DOT com> and Andrew Moore <amoore AT mooresystems DOT com>.

This library is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.