GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PERL::CRITIC::POLICY::BANGS::PROHIBITVAGUENAMES (3)

.ds Aq ’

NAME

Perl::Critic::Policy::Bangs::ProhibitVagueNames - Don’t use generic variable names.

CONTENTS

AFFILIATION

This Policy is part of the Perl::Critic::Bangs distribution.

DESCRIPTION

Variables should have descriptive names. Names like $data and $info are completely vague.



   my $data = shift;      # not OK.
   my $userinfo = shift   # OK



See <http://www.oreillynet.com/onlamp/blog/2004/03/the_worlds_two_worst_variable.html> for more of my ranting on this.

CONFIGURATION

This policy has two options: names and add_names.

CWnames

To replace the list of vague names, specify them as a whitespace delimited set of prohibited names.



    [Bangs::ProhibitVagueNames]
    names = data count line next



CWadd_names

To add to the list of vague names, specify them as a whitespace delimited set of prohibited names.



    [Bangs::ProhibitVagueNames]
    add_names = foo bar bat



AUTHOR

Andy Lester <andy at petdance.com> from code by Andrew Moore <amoore at mooresystems.com>.

ACKNOWLEDGMENTS

Adapted from policies by Jeffrey Ryan Thalhammer <thaljef@cpan.org>, Based on App::Fluff by Andy Lester, <andy at petdance.com>

COPYRIGHT

Copyright (c) 2006-2011 Andy Lester

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PERL::CRITIC::POLICY::BANGS::PROHIBITVAGUENAMES (3) 2011-06-20

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.