Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Perl::Critic::Bangs(3)User Contributed Perl DocumentatioPerl::Critic::Bangs(3)

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

VERSION
       Version 1.08

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

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:

       o   AnnoCPAN: Annotated CPAN documentation

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

       o   CPAN	Ratings

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

       o   RT: CPAN's request tracker

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

       o   Search CPAN

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

       o   Source code repository

	   <http://github.com/petdance/perl-critic-bangs>

ACKNOWLEDGMENTS
       Thanks to

       o   Andy	Moore for helping me get this off the ground.

       o   Oystein Torget for bug reports and patches.

       o   Mike	O'Regan	for ProhibitBitwiseOperators.

       o   Elliot Shank	and the	rest of	the Perl::Critic team for ongoing
	   support.

COPYRIGHT
       Copyright 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.

perl v5.24.1			  2011-06-20		Perl::Critic::Bangs(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | WHY IS IT CALLED Perl::Critic::Bangs? | AUTHOR | BUGS | SUPPORT | ACKNOWLEDGMENTS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Perl::Critic::Bangs&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help