Limbic~Region. In part, my reason for asking for links of what people found to be good examples was an attempt to discover whether anyone ever found somebody elses comments good, rather than just their own (idea of what would make) good commenting.

My own contention is that:

  1. many people have high ideals with regard to commenting.
  2. these rarely coincide.
  3. almost noone sticks to their own ideals.
  4. almost noone has ever seen an exampe of someone elses commenting that (sufficiently) complies with their own ideals for them to hold it up as an example.
  5. that even those rare pieces of code that start out containing good commenting, lapse into the melee of unmaintaind, out-of-date, and irrelavent over time.

That's not to say that there aren't good uses for comments. Just that over time, they become less good.

Personally, if find it easier to write the code than a (good) comment about it.

Historically I've found that if I don't understand the code, the associated comments rarely help and often hinder. Indeed, if I want to work out what a compex piece of code is doing, especially if it is my intention to modify that code, I found that deleting the comments and reading the code is the only way (for me).

Occasionally, if the commenting is detailed enough, it serves to show up a distinction between what the author thought they were coding and what they actually coded--which I guess serves a purpose, but any commenting that is detailed enough for that to be true, will usually be described as "over-commented", even by those that encourage commenting.


Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
Lingua non convalesco, consenesco et abolesco. -- Rule 1 has a caveat! -- Who broke the cabal?
"Science is about questioning the status quo. Questioning authority".
The "good enough" maybe good enough for the now, and perfection maybe unobtainable, but that should not preclude us from striving for perfection, when time, circumstance or desire allow.

In reply to Re^2: The art of comments: (rave from the grave) by BrowserUk
in thread The art of comments: (rave from the grave) by BrowserUk

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.