What are you commenting and why? There isn't, IMO, any hard and fast rule.

My opinion is that most of the time, most code does not need commenting upon. But your public interfaces should always be commented. In my code what I intend to be public is generally fairly obvious - it is what you see comments next to. :-)

I explained my views in more detail in the thread starting at Re (tilly) 1: What you want and perl advocacy gone way wrong. (In that thread look for the post by IO, really.) I would also recommend The Pragmatic Programmer and Code Complete for two other books that offer good advice about the issues that commenting raises.

In reply to Re (tilly) 1: Another commenting question, by tilly
in thread Another commenting question, by scottstef

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.