Changeset 2474

Timestamp:

Nov 24, 2004, 4:23:35 PM (22 years ago)

Author:

jhoblitt

Message:

misc clarifications
allow the rule about trailing comments to be ignored because perltidy will reformat code in the conforming style.

File:

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

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.35 2004-11-25 02:02:33 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.36 2004-11-25 02:23:35 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -348 +348 @@
 
 Comments should not be used to comment out large sections of code.  When
-deactivating 2 or fewer lines of code a double hash (\code{##}) should be used
-at the very beginning of the line(s).
+deactivating 2 or fewer consecutive lines of code a double hash (\code{##})
+should be used at the very beginning of the line(s).
 
 Example of deactivating a single line code.
@@ -361 +361 @@
 When deactivating 3 or more lines of code an \code{if} statement should be used
 with a false boolean value.  The opening and closing of the \code{if} statement
-must be at the very beginning of the line.
+should be nest to the same depth as the surrounding code and the deactivated
+section should be indented.
 
 Example of deactivating multiple lines of code.
@@ -442 +443 @@
     }
 \end{verbatim}
+
+\emph{\code{perltidy} is incapable of formatting trailing comments in this
+style.  It will force trailing comments to be 4 spaces to the right of the last
+character in any statement on the line.  However, it will add additional spaces
+to cause trailing comments in adjoining lines to be vertically aligned.  Until
+such time as \code{perltidy} can following this convention or a replacement
+tool is located, code as formatted by \code{perltidy} will be considered
+acceptable.}
 
 \subsection{API Comments}