I hardly ever comment my code and the documentation I DO write sucks bigtime... There, I said it... happy now?? :))

Like mentioned before commenting code should be a reflex, and someday I will train it. Right now I'm lazy (and Larry said Laziness is a virtue). I doubt you can have TOO much documentation, like you can't have TOO much sex (hear that, hun??) or TOO much O'Reilly (Manning too) Perl books.

I get comments constantly for not providing documentation and POD for my code/apps; my excuse usually is something like 'But it's still beta... I'd be a fool writing documentation for code that's probably gone change anyway...'.

If New Year were today, my New Year's resolution would definitly include writing more documentation and POD, together with finally security checking code, bribing vroom with beer again and slowing down my XP gaining so OeufMayo can catch up.

Greetz
Beatnik
... Quidquid perl dictum sit, altum viditur.

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