Adding vertical white space is a good idea if you have a 300-line routine. A much better idea is to factor out the conceptual chunks into reasonably-sized routines.
I try very consciously to add whitespace between "paragraphs" in my programs,
and to order the code into reasonable "paragraphs" and "subsections", usually
flagged with additional comments as to the purpose of the following section.
You can see evidence of this in
my columns.
I also tend to minimalize the comments to just those things that carry context.
I try to let the Perl code speak for itself, and don't define anything that they
can get from a perusal of the first half dozen entries in perldoc perl.
But if I have an algorithm, or a dependency that wouldn't necessarily be obvious,
that becomes the comment.
-- Randal L. Schwartz, Perl hacker
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
