.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::Variables::ProhibitLocalVars 3pm"
.TH Perl::Critic::Policy::Variables::ProhibitLocalVars 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::Variables::ProhibitLocalVars \- Use "my" instead of "local", except when you have to.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Since Perl 5, there are very few reasons to declare \f(CW\*(C`local\*(C'\fR
variables.  The most common exceptions are Perl's magical global
variables.  If you do need to modify one of those global variables,
you should localize it first.  You should also use the
English module to give those variables more meaningful
names.
.PP
.Vb 2
\&    local $foo;   #not ok
\&    my $foo;      #ok
\&
\&    use English qw(\-no_match_vars);
\&    local $INPUT_RECORD_SEPARATOR    #ok
\&    local $RS                        #ok
\&    local $/;                        #not ok
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH NOTES
.IX Header "NOTES"
If an external module uses package variables as its interface, then
using \f(CW\*(C`local\*(C'\fR is actually a pretty sensible thing to do.  So
Perl::Critic will not complain if you \f(CW\*(C`local\*(C'\fR\-ize variables with a
fully qualified name such as \f(CW$Some::Package::foo\fR.  However, if
you're in a position to dictate the module's interface, I strongly
suggest using accessor methods instead.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Policy::Variables::ProhibitPunctuationVars
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2011 Imaginative Software Systems.  All rights reserved.
.PP
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.