6. Write a lot of comments, especially about the purpose of a code chunk.

Time for me to beat my "comments" drum again.

Ideally comments should not explain the purpose of a code block. The purpose should be self-evident. Moving your code out to a well named method/sub can often help greatly with this.

Instead, comments should explain the WHY behind the particular manner in which you achieve your purpose. Any average programmer should be able to read your code and see easily enough what it does. But even a great programmer might have difficult knowning why you did it a certain way. That's where good comments save a lot of head-scratching.

Tony

Tony

In reply to Re: Re: Rules of Proper Perl Style by salvadors
in thread Rules of Proper Perl Style by sierrathedog04

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.