How much trust should you have in comments?

Over the course of 25 years slinging code, my answer is "less and less." I've been burned too many times by elaborate commentary that had little relation to the "truth" of what the system was really doing. Commentary rarely survives program growth and maintenance.

The commentary I tend to trust are "what does this do?" comments, if they're brief. The larger the comment, the less I tend to trust it. I also pay a lot of attention to "BUG", "FIXME", and "TBD" comments, though conceptually these are more like Post-It markers in the code.

POD is really something different. It's external documentation that's been entwined in the code.

In reply to Re: No Comment by dws
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.