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


Perl-Critic-Bangs documentation  | view source Contained in the Perl-Critic-Bangs distribution.

Index


NAME

Top

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

AFFILIATION

Top

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

DESCRIPTION

Top

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

Top

This policy has two options: names and add_names.

names

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

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

add_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

Top

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

ACKNOWLEDGMENTS

Top

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

COPYRIGHT

Top


Perl-Critic-Bangs documentation  | view source Contained in the Perl-Critic-Bangs distribution.