if you're going through all this trouble, why aren't you using pod? then anyone can view your docs by typing perldoc myscript.pl

as to your question, it depends on how important the code is. i'd document the entire module with pod at the end, but others prefer it interleaved with code. and if i had seventeen similar methods in the same module, i'd certainly try to consolidate the information a little more than the example you've provided.

and this wasn't in your question, but i believe good tests are worth as much as good documentation. write tests as you code, and you'll begin to see why. i've even written a set of ksh test procedures for my current client -- which has improved code quality quite a bit already.

~Particle *accelerates*

In reply to Re: Am I over-commenting my code? by particle
in thread Am I over-commenting my code? by belden

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.