Perl::Critic::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames - Don't use labels that are the same as the special block names.


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

Index


NAME

Top

Perl::Critic::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames - Don't use labels that are the same as the special block names.

AFFILIATION

Top

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

DESCRIPTION

Top

When using one of the special Perl blocks BEGIN, END, CHECK, INIT, and UNITCHECK, it is easy to mistakenly add a colon to the end of the block name. E.g.:

    # a BEGIN block that gets executed at compile time.
    BEGIN { <...code...> }

    # an ordinary labeled block that gets executed at run time.
    BEGIN: { <...code...> }

The labels "BEGIN:", "END:", etc. are probably errors. This policy prohibits the special Perl block names from being used as labels.

CONFIGURATION

Top

This Policy is not configurable except for the standard options.

SEE ALSO

Top

The Perl Buzz article on this issue at http://perlbuzz.com/2008/05/colons-invalidate-your-begin-and-end-blocks.html.

ACKNOWLEDGMENT

Top

Randy Lauen for identifying the problem.

AUTHOR

Top

Mike O'Regan

COPYRIGHT

Top


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