View on
MetaCPAN
Andy Lester > Perl-Critic-Bangs > Perl::Critic::Bangs

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

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.12   Source  

NAME ^

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

VERSION ^

Version 1.12

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:

Perl::Critic::Policy::Bangs::ProhibitCommentedOutCode

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

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

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

Perl::Critic::Policy::Bangs::ProhibitNoPlan

Tests should have a plan.

Perl::Critic::Policy::Bangs::ProhibitNumberedNames

Subroutines and variables like $user and $user2 are insufficiently distinguished.

Perl::Critic::Policy::Bangs::ProhibitRefProtoOrProto

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

Perl::Critic::Policy::Bangs::ProhibitUselessTopic

Explicitly matching or substituting against $_ is clutter.

Perl::Critic::Policy::Bangs::ProhibitUselessRegexModifiers

Adding 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::ProhibitVagueNames

Vague variables and subroutines 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" since 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:

ACKNOWLEDGMENTS ^

Thanks to William Braswell, Oliver Trosien, Fred Moyer, Andy Moore, Oystein Torget, Mike O'Regan, Elliot Shank and the rest of the Perl::Critic team for ongoing support.

COPYRIGHT ^

Copyright 2006-2017 Andy Lester.

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

syntax highlighting: