|
NAMEPerl::Critic::Bangs - A collection of handy Perl::Critic policiesVERSIONVersion 1.08SYNOPSISPerl::Critic::Bangs is a collection of Perl::Critic policies that will help make your code better.DESCRIPTIONThe rules included with the Perl::Critic::Bangs group include:Perl::Critic::Policy::Bangs::ProhibitCommentedOutCodeCommented-out code is usually noise. It should be removed.Perl::Critic::Policy::Bangs::ProhibitFlagCommentsWatch for comments like "XXX", "TODO", etc.Perl::Critic::Policy::Bangs::ProhibitNoPlanTests should have a plan.Perl::Critic::Policy::Bangs::ProhibitNumberedNamesVariables like $user and $user2 are insufficiently distinguished.Perl::Critic::Policy::Bangs::ProhibitRefProtoOrProtoDetermining the class in a constructor by using "ref($proto) || $proto" is usually a cut-n-paste that is incorrect.Perl::Critic::Policy::Bangs::ProhibitUselessRegexModifiersAdding modifiers to a regular expression made up entirely of a variable created with "qr()" is usually not doing what you expect.Perl::Critic::Policy::Bangs::ProhibitVagueNamesVague variables like $data or $info are not descriptive enough.WHY IS IT CALLED Perl::Critic::Bangs?I didn't want to call it "Perl::Critic::Lester" or "Perl::Critic::Petdance" that would make it sound like they were only my rules. Other people will likely include their own set of rules, too.So I started thinking of names of famous critics. Ebert, Siskel, Kael, etc. What about music critics? Greil Marcus, J.D. Considine... Lester Bangs! He's even got my name in his! So there was the name. See http://en.wikipedia.org/wiki/Lester_Bangs for more on Lester Bangs. AUTHORAndy Lester, "<andy at petdance.com>"BUGSPlease report any bugs or feature requests to "bug-perl-critic-bangs at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Critic-Bangs>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.SUPPORTYou can find documentation for this module with the perldoc command.perldoc Perl::Critic::Bangs You can also look for information at:
ACKNOWLEDGMENTSThanks to
COPYRIGHTCopyright 2006-2011 Andy Lester.This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.
Visit the GSP FreeBSD Man Page Interface. |