Yup. :-)

The NAME section is entirely redundant; you can safely get away without telling the reader that a routine declared as sub dump_subtable is called "dump_subtable" and dumps a subtable. As for the rest, well, it depends. If this is an interface function, then spelling out the options, listing bugs, and providing several examples is good and useful, but should probably be POD rather than comments. If it's a utility function that doesn't get exported, then IMO you'd probably be better off with a small comment block at the top, and maybe some useful comments inline.

--
The hell with paco, vote for Erudil!
/msg me if you downvote this node, please.
:wq

In reply to Re: Am I over-commenting my code? by FoxtrotUniform
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.