I was taught this same lesson by a firmware programmer who didn't want to read the documentation for the hardware that I had designed. He just wanted to look at my schematics!

I like to have one comment at the top of each file that says what the program or module is supposed to do. I also like to comment my bugs or poorly written code. I can tell that the code is okay when all of the comments are gone and I can still easily read the code.

If the code is a module that is intended to be used more than once, writing the pod documentation is still a good idea. This is different from code comments, though. If the module is well-written, it probably won't be subjected to cut-and-paste, it will get used properly.

It should work perfectly the first time! - toma

In reply to Re: No Comment by toma
in thread No Comment by awkmonk

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.