Changeset 2424 for trunk/doc/misc/perlCodeConventions.tex

Timestamp:

Nov 24, 2004, 2:08:25 AM (22 years ago)

Author:

jhoblitt

Message:

misc clarifications

File:

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

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.32 2004-11-23 23:37:29 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.33 2004-11-24 12:08:25 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -915 +915 @@
 \subsection{When to Make Symbols Global}
 
-Only declare variables as package variables (\code{our}) if they are going to
-be exported into another namespace.  All other variables within a namespace
-should be declared as lexical.
-
-\begin{verbatim}
+Only declare variables as package variables (\code{our}) if they are intended
+to be visible outside of the current namespace.  All other variables within a
+namespace should be declared as lexical.
+
+\begin{verbatim}
+    our $VERSION = '1.00';                  # Correct
+
     use base qw( Exporter );
 
-    our @EXPORT_OK = qw( $foo $bar );
+    our @EXPORT_OK = qw( $foo $bar );       # Correct
+
+    our $localCounter;                      # AVOID!
 \end{verbatim}
 
@@ -1166 +1170 @@
 
 \code{pertidy} can be configured with either command line switches or a
-\file{.perltidyrc} file in your home directory.
+\file{.perltidyrc} file in your home directory.  Detailed instructions on how
+to configure \code{perltidy} can be found in it's manpage\footnote{Perltidy
+manpage - http://perltidy.sourceforge.net/perltidy.html}
 
 Example \file{.perltidyrc} file to achieve the Perl code convention: