1Perl::Critic::Bangs(3)User Contributed Perl DocumentationPerl::Critic::Bangs(3)
2
3
4
6 Perl::Critic::Bangs - A collection of handy Perl::Critic policies
7
9 Version 1.12
10
12 Perl::Critic::Bangs is a collection of Perl::Critic policies that will
13 help make your code better.
14
16 The rules included with the Perl::Critic::Bangs group include:
17
18 Perl::Critic::Policy::Bangs::ProhibitCommentedOutCode
19 Commented-out code is usually noise. It should be removed.
20
21 Perl::Critic::Policy::Bangs::ProhibitFlagComments
22 Watch for comments like "XXX", "TODO", etc.
23
24 Perl::Critic::Policy::Bangs::ProhibitNoPlan
25 Tests should have a plan.
26
27 Perl::Critic::Policy::Bangs::ProhibitNumberedNames
28 Subroutines and variables like $user and $user2 are insufficiently
29 distinguished.
30
31 Perl::Critic::Policy::Bangs::ProhibitRefProtoOrProto
32 Determining the class in a constructor by using "ref($proto) || $proto"
33 is usually a cut-n-paste that is incorrect.
34
35 Perl::Critic::Policy::Bangs::ProhibitUselessTopic
36 Explicitly matching or substituting against $_ is clutter.
37
38 Perl::Critic::Policy::Bangs::ProhibitUselessRegexModifiers
39 Adding modifiers to a regular expression made up entirely of a variable
40 created with "qr()" is usually not doing what you expect.
41
42 Perl::Critic::Policy::Bangs::ProhibitVagueNames
43 Vague variables and subroutines like $data or $info are not descriptive
44 enough.
45
47 I didn't want to call it "Perl::Critic::Lester" or
48 "Perl::Critic::Petdance" since that would make it sound like they were
49 only my rules. Other people will likely include their own set of
50 rules, too.
51
52 So I started thinking of names of famous critics. Ebert, Siskel, Kael,
53 etc. What about music critics? Greil Marcus, J.D. Considine... Lester
54 Bangs! He's even got my name in his! So there was the name.
55
56 See http://en.wikipedia.org/wiki/Lester_Bangs for more on Lester Bangs.
57
59 Andy Lester, "<andy at petdance.com>"
60
62 Please report any bugs or feature requests to "bug-perl-critic-bangs at
63 rt.cpan.org", or through the web interface at
64 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Critic-Bangs>. I
65 will be notified, and then you'll automatically be notified of progress
66 on your bug as I make changes.
67
69 You can find documentation for this module with the perldoc command.
70
71 perldoc Perl::Critic::Bangs
72
73 You can also look for information at:
74
75 · AnnoCPAN: Annotated CPAN documentation
76
77 <http://annocpan.org/dist/Perl-Critic-Bangs>
78
79 · CPAN Ratings
80
81 <http://cpanratings.perl.org/d/Perl-Critic-Bangs>
82
83 · RT: CPAN's request tracker
84
85 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Critic-Bangs>
86
87 · Search CPAN
88
89 <http://search.cpan.org/dist/Perl-Critic-Bangs>
90
91 · Source code repository
92
93 <http://github.com/petdance/perl-critic-bangs>
94
96 Thanks to William Braswell, Oliver Trosien, Fred Moyer, Andy Moore,
97 Oystein Torget, Mike O'Regan, Elliot Shank and the rest of the
98 Perl::Critic team for ongoing support.
99
101 Copyright 2006-2017 Andy Lester.
102
103 This program is free software; you can redistribute it and/or modify it
104 under the terms of the Artistic License 2.0.
105
106
107
108perl v5.30.0 2019-07-26 Perl::Critic::Bangs(3)