perl::critic::annotation(3pm) [debian man page]
Perl::Critic::Annotation(3pm) User Contributed Perl Documentation Perl::Critic::Annotation(3pm) NAME
Perl::Critic::Annotation - A "## no critic" annotation in a document. SYNOPSIS
use Perl::Critic::Annotation; $annotation = Perl::Critic::Annotation->new( -element => $no_critic_ppi_element ); $bool = $annotation->disables_line( $number ); $bool = $annotation->disables_policy( $policy_object ); $bool = $annotation->disables_all_policies(); ($start, $end) = $annotation->effective_range(); @disabled_policy_names = $annotation->disabled_policies(); DESCRIPTION
"Perl::Critic::Annotation" represents a single "## no critic" annotation in a <PPI:Document>. The Annotation takes care of parsing the annotation and keeps track of which lines and Policies it affects. It is intended to encapsulate the details of the no-critic annotations, and to provide a way for Policy objects to interact with the annotations (via a Perl::Critic::Document). INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject to change without notice. CLASS METHODS
create_annotations( -doc => $doc ) Given a Perl::Critic::Document, finds all the "## no critic" annotations and constructs a new "Perl::Critic::Annotation" for each one and returns them. The order of the returned objects is not defined. It is generally expected that clients will use this interface rather than calling the "Perl::Critic::Annotation" constructor directly. CONSTRUCTOR
"new( -element => $ppi_annotation_element )" Returns a reference to a new Annotation object. The -element argument is required and should be a "PPI::Token::Comment" that conforms to the "## no critic" syntax. METHODS
"disables_line( $line )" Returns true if this Annotation disables $line for any (or all) Policies. "disables_policy( $policy_object )" "disables_policy( $policy_name )" Returns true if this Annotation disables $polciy_object or $policy_name at any (or all) lines. "disables_all_policies()" Returns true if this Annotation disables all Policies at any (or all) lines. If this method returns true, "disabled_policies" will return an empty list. "effective_range()" Returns a two-element list, representing the first and last line numbers where this Annotation has effect. "disabled_policies()" Returns a list of the names of the Policies that are affected by this Annotation. If this list is empty, then it means that all Policies are affected by this Annotation, and "disables_all_policies()" should return true. "element()" Returns the PPI::Element where this annotation started. This is typically an instance of PPI::Token::Comment. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. 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. perl v5.14.2 2012-06-07 Perl::Critic::Annotation(3pm)
Check Out this Related Man Page
Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritUser)Contributed Perl DocumenPerl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic(3) NAME
Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic - Remove ineffective "## no critic" annotations. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
Sometimes, you may need to use a "## no critic" annotation to work around a false-positive bug in Perl::Critic. But eventually, that bug might get fixed, leaving your code with extra "## no critic" annotations lying about. Or you may use them to locally disable a Policy, but then later decide to permanently remove that Policy entirely from your profile, making some of those "## no critic" annotations pointless. Or, you may accidentally disable too many Policies at once, creating an opportunity for new violations to slip in unnoticed. This Policy will emit violations if you have a "## no critic" annotation in your source code that does not actually suppress any violations given your current profile. To resolve this, you should either remove the annotation entirely, or adjust the Policy name patterns in the annotation to match only the Policies that are actually being violated in your code. EXAMPLE
For example, let's say I have a regex, but I don't want to use the "/x" flag, which violates the "RegularExpressions::RequireExtendedFormatting" policy. In the following code, the "## no critic" annotation will suppress violations of that Policy and ALL Policies that match "m/RegularExpressions/imx" my $re = qr/foo bar baz/ms; ## no critic (RegularExpressions) However, this creates a potential loop-hole for someone to introduce additional violations in the future, without explicitly acknowledging them. This Policy is designed to catch these situations by warning you that you've disabled more Policies than the situation really requires. The above code should be remedied like this: my $re = qr/foo bar baz/ms; ## no critic (RequireExtendedFormatting) Notice how the "RequireExtendedFormatting" pattern more precisely matches the name of the Policy that I'm trying to suppress. NOTE
Changing your .perlcriticrc file and disabling policies globally or running at a higher (i.e. less restrictive) severity level may cause this Policy to emit additional violations. So you might want to defer using this Policy until you have a fairly stable profile. CONFIGURATION
This Policy is not configurable except for the standard options. ACKNOWLEDGMENT
This Policy was inspired by Adam Kennedy's article at <http://use.perl.org/article.pl?sid=08/09/24/1957256>. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. 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. perl v5.16.3 2014-06-09 Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic(3)