I don't think there is anything wrong with too documentation, if anything... there is something wrong with too less documentation (I know, bad grammer.. but you get the gist). Documentation doesn't slow code down - but it does make it understandable to those who must follow in your footsteps later to maintain it. Even if you maintain that code, months later you may forget exactly what you're trying to do in a certain function or whatnot - and documenation helps trigger the memory or explain it completely. Although many programmers detest documentation or documenting their own code - it's something that they're rather thankful when inheriting a project. It doesn't take too much effort and it saves time down the road... here are a few other nodes that have talked about documentation. Check out use documentation; and Danger, danger Will Robinson (documenting code).

In reply to Re: Too much documentation? by LD2
in thread 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.