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

Timestamp:

Nov 24, 2004, 3:51:32 PM (22 years ago)

Author:

jhoblitt

Message:

add sections on inheritance and subroutine calling

File:

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

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.33 2004-11-24 12:08:25 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.34 2004-11-25 01:51:32 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -1147 +1147 @@
 \end{verbatim}
 
+\subsubsection{Inheritance}
+
+Don't use the \code{@ISA} package variable for subclassing.  Instead, use the
+\code{base} pragma.
+
+\begin{verbatim}
+    use base qw( Foo );                 # Correct
+    our @ISA = qw( Foo );               # AVOID!
+\end{verbatim}
+
+\subsubsection{Calling Subroutines}
+
+Do not use the \code{&} sigil to to disambiguate a subroutine from a
+``bare-word''.  Instead, use empty parentheses adjoined to the subroutine call.
+
+\code{subs} pragma is a last resort.
+
+\begin{verbatim}
+    fooBar($foo);                       # Correct
+    fooBar();                           # Correct
+    &fooBar;                            # AVOID!
+    &fooBar();                          # AVOID!
+    use subs qw( fooBar );              # last resort - Correct
+\end{verbatim}
+
 %------------------------------------------------------------------------------
 \appendix                               %Begin Appendices