sourCEntral - mobile manpages

pdf

Perl::Critic::Policy::Bangs::ProhibitVagueNames

NAME

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

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

"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

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

ACKNOWLEDGMENTS

Adapted from policies by Jeffrey Ryan Thalhammer <thaljef AT cpan DOT 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.

pdf