Andy Lester > Perl-Critic-Bangs-0.22 > Perl::Critic::Policy::Bangs::ProhibitFlagComments

Download:
Perl-Critic-Bangs-0.22.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  8
Open  0
View Bugs
Report a bug
Source  

NAME ^

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

DESCRIPTION ^

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

CONSTRUCTOR ^

By default, this policy only looks for 'XXX', 'TODO', or 'FIXME' in comments. To add words, pass them into the constructor as a key-value pair, where the key is 'keywords' and the value is a whitespace delimited series of keywords. Or specify them in your .perlcriticrc file like this:

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

AUTHOR ^

Andrew Moore <amoore@mooresystems.com>

ACKNOWLEDGEMENTS ^

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

COPYRIGHT ^

Copyright (c) 2006 Andrew Moore <amoore@mooresystems.com>. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.