NAME

Perl::Critic::Policy::Bangs::ProhibitVagueNames - Prohibit vague variable names

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.

CONSTRUCTOR

To replace the list of vague names, pass them into the constructor as a key-value pair where the key is "names" and the value is a whitespace delimited series of names. Or specify them in your .perlcriticrc file like this:

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

To add names to the list, pass them into the constructor as "add_names", or specify them in your .perlcriticrc file like this:

[Bangs::ProhibitVagueNames]
add_names = foo bar bat

AUTHOR

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

ACKNOWLEDGEMENTS

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 Andy Lester. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.