perl::critic::policyparameter(3pm) [debian man page]
Perl::Critic::PolicyParameter(3pm) User Contributed Perl Documentation Perl::Critic::PolicyParameter(3pm) NAME
Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy. DESCRIPTION
A provider of validation and parsing of parameter values and metadata about the parameter. INTERFACE SUPPORT
This is considered to be a public class. Any changes to its interface will go through a deprecation cycle. METHODS
"get_name()" Return the name of the parameter. This is the key that will be looked for in the .perlcriticrc. "get_description()" Return an explanation of the significance of the parameter, as provided by the developer of the policy. "get_default_string()" Return a representation of the default value of this parameter as it would appear if it was specified in a .perlcriticrc file. "parse_and_validate_config_value( $parser, $config )" Extract the configuration value for this parameter from the overall configuration and initialize the policy based upon it. "generate_full_description()" Produce a more complete explanation of the significance of this parameter than the value returned by "get_description()". If no description can be derived, returns the empty string. Note that the result may contain multiple lines. "to_formatted_string( $format )" Generate a string representation of this parameter, based upon the format. The format is a combination of literal and escape characters similar to the way "sprintf" works. If you want to know the specific formatting capabilities, look at String::Format. Valid escape characters are: %n The name of the parameter. %d The description, as supplied by the programmer. %D The default value, in a parsable form. %f The full description, which is an extension of the value returned by %d. Takes a parameter of a prefix for the beginning of each line. SEE ALSO
"MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER AUTHOR
Elliot Shank <perl@galumph.com> COPYRIGHT
Copyright (c) 2006-2011 Elliot Shank. 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. perl v5.14.2 2012-06-07 Perl::Critic::PolicyParameter(3pm)
Check Out this Related Man Page
Perl::Critic::Policy::ValuesAndExpressions::ProhibitQuPerl::Critic::Policy::ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters(3pm) NAME
Perl::Critic::Policy::ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters - Don't use quotes ("'", """, "`") as delimiters for the quote-like operators. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
With the obvious exception of using single-quotes to prevent interpolation, using quotes with the quote-like operators kind of defeats the purpose of them and produces obfuscated code, causing problems for future maintainers and their editors/IDEs. $x = q"q"; #not ok $x = q'q'; #not ok $x = q`q`; #not ok $x = qq"q"; #not ok $x = qr"r"; #not ok $x = qw"w"; #not ok $x = qx`date`; #not ok $x =~ m"m"; #not ok $x =~ s"s"x"; #not ok $x =~ tr"t"r"; #not ok $x =~ y"x"y"; #not ok $x =~ m'$x'; #ok $x =~ s'$x'y'; #ok $x = qr'$x'm; #ok $x = qx'finger foo@bar'; #ok CONFIGURATION
This policy has three options: "single_quote_allowed_operators", "double_quote_allowed_operators", and "back_quote_allowed_operators", which control which operators are allowed to use each of "'", """, "`" as delimiters, respectively. The values allowed for these options are a whitespace delimited selection of the "m", "q", "qq", "qr", "qw", "qx", "s", "tr", and "y" operators. By default, double quotes and back quotes (backticks) are not allowed as delimiters for any operators and single quotes are allowed as delimiters for the "m", "qr", "qx", and "s" operators. These defaults are equivalent to having the following in your .perlcriticrc: [ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters] single_quote_allowed_operators = m s qr qx double_quote_allowed_operators = back_quote_allowed_operators = SUGGESTED BY
Michael Schwern AUTHOR
Elliot Shank "<perl@galumph.com>" COPYRIGHT
Copyright (c) 2007-2011 Elliot Shank. 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. perl v5.14.2 Perl::Critic::Policy::ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters(3pm)