1PERLSTYLE(1) Perl Programmers Reference Guide PERLSTYLE(1)
2
6 perlstyle - Perl style guide
7
9 Each programmer will, of course, have his or her own preferences in
10 regards to formatting, but there are some general guidelines that will
11 make your programs easier to read, understand, and maintain.
12 The most important thing is to run your programs under the -w flag at
14 all times. You may turn it off explicitly for particular portions of
15 code via the "no warnings" pragma or the $^W variable if you must. You
16 should also always run under "use strict" or know the reason why not.
17 The "use sigtrap" and even "use diagnostics" pragmas may also prove
18 useful.
19 Regarding aesthetics of code lay out, about the only thing Larry cares
21 strongly about is that the closing curly bracket of a multi-line BLOCK
22 should line up with the keyword that started the construct. Beyond
23 that, he has other preferences that aren't so strong:
24 · 4-column indent.
26 · Opening curly on same line as keyword, if possible, otherwise line
28 up.
29 · Space before the opening curly of a multi-line BLOCK.
31 · One-line BLOCK may be put on one line, including curlies.
33 · No space before the semicolon.
35 · Semicolon omitted in "short" one-line BLOCK.
37 · Space around most operators.
39 · Space around a "complex" subscript (inside brackets).
41 · Blank lines between chunks that do different things.
43 · Uncuddled elses.
45 · No space between function name and its opening parenthesis.
47 · Space after each comma.
49 · Long lines broken after an operator (except "and" and "or").
51 · Space after last parenthesis matching on current line.
53 · Line up corresponding items vertically.
55 · Omit redundant punctuation as long as clarity doesn't suffer.
57 Larry has his reasons for each of these things, but he doesn't claim
59 that everyone else's mind works the same as his does.
60 Here are some other more substantive style issues to think about:
62 · Just because you CAN do something a particular way doesn't mean
64 that you SHOULD do it that way. Perl is designed to give you
65 several ways to do anything, so consider picking the most readable
66 one. For instance
67 open(FOO,$foo) || die "Can't open $foo: $!";
69 is better than
71 die "Can't open $foo: $!" unless open(FOO,$foo);
73 because the second way hides the main point of the statement in a
75 modifier. On the other hand
76 print "Starting analysis\n" if $verbose;
78 is better than
80 $verbose && print "Starting analysis\n";
82 because the main point isn't whether the user typed -v or not.
84 Similarly, just because an operator lets you assume default
86 arguments doesn't mean that you have to make use of the defaults.
87 The defaults are there for lazy systems programmers writing one-
88 shot programs. If you want your program to be readable, consider
89 supplying the argument.
90 Along the same lines, just because you CAN omit parentheses in many
92 places doesn't mean that you ought to:
93 return print reverse sort num values %array;
95 return print(reverse(sort num (values(%array))));
96 When in doubt, parenthesize. At the very least it will let some
98 poor schmuck bounce on the % key in vi.
99 Even if you aren't in doubt, consider the mental welfare of the
101 person who has to maintain the code after you, and who will
102 probably put parentheses in the wrong place.
103 · Don't go through silly contortions to exit a loop at the top or the
105 bottom, when Perl provides the "last" operator so you can exit in
106 the middle. Just "outdent" it a little to make it more visible:
107 LINE:
109 for (;;) {
110 statements;
111 last LINE if $foo;
112 next LINE if /^#/;
113 statements;
114 }
115 · Don't be afraid to use loop labels--they're there to enhance
117 readability as well as to allow multilevel loop breaks. See the
118 previous example.
119 · Avoid using "grep()" (or "map()") or `backticks` in a void context,
121 that is, when you just throw away their return values. Those
122 functions all have return values, so use them. Otherwise use a
123 "foreach()" loop or the "system()" function instead.
124 · For portability, when using features that may not be implemented on
126 every machine, test the construct in an eval to see if it fails.
127 If you know what version or patchlevel a particular feature was
128 implemented, you can test $] ($PERL_VERSION in "English") to see if
129 it will be there. The "Config" module will also let you
130 interrogate values determined by the Configure program when Perl
131 was installed.
132 · Choose mnemonic identifiers. If you can't remember what mnemonic
134 means, you've got a problem.
135 · While short identifiers like $gotit are probably ok, use
137 underscores to separate words in longer identifiers. It is
138 generally easier to read $var_names_like_this than
139 $VarNamesLikeThis, especially for non-native speakers of English.
140 It's also a simple rule that works consistently with
141 "VAR_NAMES_LIKE_THIS".
142 Package names are sometimes an exception to this rule. Perl
144 informally reserves lowercase module names for "pragma" modules
145 like "integer" and "strict". Other modules should begin with a
146 capital letter and use mixed case, but probably without underscores
147 due to limitations in primitive file systems' representations of
148 module names as files that must fit into a few sparse bytes.
149 · You may find it helpful to use letter case to indicate the scope or
151 nature of a variable. For example:
152 $ALL_CAPS_HERE constants only (beware clashes with perl vars!)
154 $Some_Caps_Here package-wide global/static
155 $no_caps_here function scope my() or local() variables
156 Function and method names seem to work best as all lowercase.
158 E.g., "$obj->as_string()".
159 You can use a leading underscore to indicate that a variable or
161 function should not be used outside the package that defined it.
162 · If you have a really hairy regular expression, use the "/x"
164 modifier and put in some whitespace to make it look a little less
165 like line noise. Don't use slash as a delimiter when your regexp
166 has slashes or backslashes.
167 · Use the new "and" and "or" operators to avoid having to
169 parenthesize list operators so much, and to reduce the incidence of
170 punctuation operators like "&&" and "||". Call your subroutines as
171 if they were functions or list operators to avoid excessive
172 ampersands and parentheses.
173 · Use here documents instead of repeated "print()" statements.
175 · Line up corresponding things vertically, especially if it'd be too
177 long to fit on one line anyway.
178 $IDX = $ST_MTIME;
180 $IDX = $ST_ATIME if $opt_u;
181 $IDX = $ST_CTIME if $opt_c;
182 $IDX = $ST_SIZE if $opt_s;
183 mkdir $tmpdir, 0700 or die "can't mkdir $tmpdir: $!";
185 chdir($tmpdir) or die "can't chdir $tmpdir: $!";
186 mkdir 'tmp', 0777 or die "can't mkdir $tmpdir/tmp: $!";
187 · Always check the return codes of system calls. Good error messages
189 should go to "STDERR", include which program caused the problem,
190 what the failed system call and arguments were, and (VERY
191 IMPORTANT) should contain the standard system error message for
192 what went wrong. Here's a simple but sufficient example:
193 opendir(D, $dir) or die "can't opendir $dir: $!";
195 · Line up your transliterations when it makes sense:
197 tr [abc]
199 [xyz];
200 · Think about reusability. Why waste brainpower on a one-shot when
202 you might want to do something like it again? Consider
203 generalizing your code. Consider writing a module or object class.
204 Consider making your code run cleanly with "use strict" and "use
205 warnings" (or -w) in effect. Consider giving away your code.
206 Consider changing your whole world view. Consider... oh, never
207 mind.
208 · Try to document your code and use Pod formatting in a consistent
210 way. Here are commonly expected conventions:
211 · use "C<>" for function, variable and module names (and more
213 generally anything that can be considered part of code, like
214 filehandles or specific values). Note that function names are
215 considered more readable with parentheses after their name,
216 that is "function()".
217 · use "B<>" for commands names like cat or grep.
219 · use "F<>" or "C<>" for file names. "F<>" should be the only Pod
221 code for file names, but as most Pod formatters render it as
222 italic, Unix and Windows paths with their slashes and
223 backslashes may be less readable, and better rendered with
224 "C<>".
225 · Be consistent.
227 · Be nice.
229perl v5.12.4 2011-06-01 PERLSTYLE(1)