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

Timestamp:

Nov 12, 2004, 5:33:53 PM (22 years ago)

Author:

jhoblitt

Message:

example corrections

File:

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

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.13 2004-11-13 03:12:31 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.14 2004-11-13 03:33:53 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -295 +295 @@
 alone file is as follows:
 
+e.g. for file Foo.pod:
+
 \begin{verbatim}
 =pod
@@ -469 +471 @@
 \begin{verbatim}
     if ($foo) {
-#        print( "foo" );
+#        print("foo");
     }
 \end{verbatim}
@@ -482 +484 @@
 if (0) {
     if ($foo) {
-        print( "foo" );
+        print("foo");
     }
 }
@@ -738 +740 @@
 \subsection{if, if-else, if elsif else Statements}
 
-\code{if} statements must always use braces {} around statements and parenthesis
+\code{if} statements must always use braces \{\} around statements and parenthesis
 () around conditionals.
 
@@ -796 +798 @@
 
 A Perlish \code{for} or \code{foreach} statement (also known as an iterator)
-should have the folliwng form:
+should have the following form:
 
 \begin{verbatim}
@@ -847 +849 @@
 MYLABEL: while (condition) {
     if (condition) {
-        next;
+        next MYLABEL;
     }
 }
@@ -980 +982 @@
 Constants &
 
-Perl's \code{constant} pragma should be used to declare constants.  Note:
-'constants' created this way can not be interpolated inside of double quoted
-strings.
+Constant names should be in all capital letters and highly descriptive.  The
+\code{constant} pragma should be used to declare constants.  Note: 'constants'
+created this way can not be interpolated inside of double quoted strings.
 
 &
-\code{use constant MAXLEN => 40;}\hfil\break
-\code{use constant LENGTH => qw(2, 4, 8);}\hfil\break
+\code{use constant PI => 3.14159265;}\hfil\break
+\code{use constant LENGTHS => qw(2, 4, 8);}\hfil\break
 \code{use constant CLASSES => (raw => 1, processed => 2);}\hfil\break
 
@@ -1001 +1003 @@
 \code{package Time::HiRes;}\hfil\break
 \code{package XML::SimpleObject;}\hfil\break
+
+\\
+
+Labels &
+
+Label names should be in all capital letters and short.  Generally they should
+attempt to describe the 'thing' being operated on by the loop they are labeling.
+
+&
+
+\code{LINE:}\hfil\break
+\code{CONNECTION:}\hfil\break
+\code{IMAGE:}\hfil\break
 
 \\