As the resident advocate of the position that commenting is not an unabashed good, I feel obliged to respond. The issue of what does and does not need comments is one that I have put a little thought into.

My all-time favorite insight comments remains Re: The Purpose of Commenting. My personal understanding of what I0 said is the style I described in some detail at Re (tilly) 4 (disagree): Another commenting question,. (That is a semi-unfortunate thread. While I like it for the comment, The public posts were paralleled by a series of private /msgs that were more friendly than the public record. I refer back to it because among other things it captured detailed thoughts about why I coded as I did right after I wrote it. But I regret the one-sidedness of the exchange.) I have been happy with that compromise between comments and code for a while now. Comments serve a purpose that code never can. But what you can communicate by coding well, you definitely should.

(In fact when I next experiment with my coding style I am likely to try commenting less than I do now.)

In reply to Re (tilly) 1: Why I'm a Pod::Nazi by tilly
in thread Why I'm a Pod::Nazi by Bobcat

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.