Changeset 2333

Timestamp:

Nov 10, 2004, 4:00:42 PM (22 years ago)

Author:

jhoblitt

Message:

separate subsection for local variables

File:

• trunk/doc/misc/perlCodeConventions.tex (modified) (5 diffs)

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.2 2004-11-11 01:55:58 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.3 2004-11-11 02:00:42 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -155 +155 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.2 2004-11-11 01:55:58 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.3 2004-11-11 02:00:42 jhoblitt Exp $
 
 use 5.008005;   # optional
@@ -212 +212 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.2 2004-11-11 01:55:58 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.3 2004-11-11 02:00:42 jhoblitt Exp $
 
 package Foo;
@@ -471 +471 @@
 \end{verbatim}
 
-\subsection{Initialization}
-
-Try to initialize local variables where they're declared.  The only
-reason not to initialize a variable where it's declared is if the
-initial value depends on some computation occurring first.
-
-In some cases it may be necessary to initialize a variable to suppress
-a compiler warning; in this case a comment should explain the circumstances.
-
-\subsection{Placement}
-
-Variables should ordinarily be declared at the top of the block in
-which they appear, unless there is some reason to declare them later.
-This allows them to be initialised as they are created, and naturally
-associates their declaration with their use.
-
-
-Indexes of loops should usually be declared on the line above loop statement.
-
-\begin{verbatim}
-my $i = 0;
-for (i < $maxLoops) {
-    # do stuff
-
-    $i++;
-}
-\end{verbatim}
+\subsection{Local Variables}
 
 Avoid \code{local} declarations that hide user declared variables from higher
@@ -510 +484 @@
     local $count;
     ...
+}
+\end{verbatim}
+
+Note: This restiction does not apply to Perl's built in variables.
+
+\subsection{Initialization}
+
+Try to initialize local variables where they're declared.  The only
+reason not to initialize a variable where it's declared is if the
+initial value depends on some computation occurring first.
+
+In some cases it may be necessary to initialize a variable to suppress
+a compiler warning; in this case a comment should explain the circumstances.
+
+\subsection{Placement}
+
+Variables should ordinarily be declared at the top of the block in
+which they appear, unless there is some reason to declare them later.
+This allows them to be initialised as they are created, and naturally
+associates their declaration with their use.
+
+
+Indexes of loops should usually be declared on the line above loop statement.
+
+\begin{verbatim}
+my $i = 0;
+for (i < $maxLoops) {
+    # do stuff
+
+    $i++;
 }
 \end{verbatim}