NAME

Perl::Critic::Bangs - A collection of handy Perl::Critic policies

VERSION

Version 0.20

SYNOPSIS

Perl::Critic::Bangs is a collection of Perl::Critic policies that will help make your code better.

DESCRIPTION

The rules included with the Perl::Critic::Bangs group include:

ProhibitCommentedOutCode

Commented-out code is usually noise. It should be removed.

ProhibitFlagComments

Watch for comments like "XXX", "TODO", etc.

ProhibitNoPlan

Tests should have a plan.

ProhibitNumberedNames

Variables like $user and $user2 are insufficiently distinguished.

ProhibitRefProtoOrProto

Determining the class in a constructor by using ref($proto) || $proto is usually a cut-n-paste that is incorrect.

ProhibitVagueNames

Vague variables like $data or $info are not descriptive enough.

WHY 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.

AUTHOR

Andy Lester, <andy at petdance.com>

BUGS

Please 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.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Perl::Critic::Bangs

You can also look for information at:

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Perl-Critic-Bangs

• CPAN Ratings

  http://cpanratings.perl.org/d/Perl-Critic-Bangs

• RT: CPAN's request tracker

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Critic-Bangs

• Search CPAN

  http://search.cpan.org/dist/Perl-Critic-Bangs

ACKNOWLEDGEMENTS

Thanks to Aaron Moore for helping me get this off the ground.

COPYRIGHT & LICENSE

Copyright 2006 Andy Lester, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm Perl::Critic::Bangs

perl -MCPAN -e shell
install Perl::Critic::Bangs