I don't think that many here will argue against documenting your code well. It's something that I have tried to do from that beginning, and have finally gotten into the habit. I try to say what's going on where, what each subroutine does/takes/returns, etc.

However, I was recently looking at my code, while working on some other projects written by others and noticed that although they used some comments (less than I would call a minimum) mine have about ten times the amount in some places. Then I started really looking at my code and noticed that, in general, my code to comments ratio ranges from 5:1 to 2:1.

Does anyone see anything wrong with this, or should I keep on doing what I'm doing? Does having a large amount of comments slow the code down, or are there other disadvantages? How do you find a balance?

melguin.

In reply to Too much documentation? by melguin

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.