I tend not to trust comments. I much prefer good unit tests, assertions, well factored code, preconditions, postconditions, etc. "Executable comments" have the huge advantage that they cannot get out of sync with the code.

One of the many things that intrigue me about perl6 is that things like .wrap, POST, PRE, typing, etc. make this sort of documentation-in-code far easier.

Favourite comment of all time, which once lived in the guts of a large system I worked on for a few years, was :

;;; I don't understand why this works?

[download]

Since the customers had access to the source this was removed at the request of some management when it was noticed. The code it sat above wasn't refactored tho' :-)

You might also find Documenting Methods/Subs of interest.

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