In addition to the other posters' advice, you may want to put the comment inside the subroutine block, like so:

sub dump_subtable { # NAME # dump_subtable() - dump a subtable # # SYNOPSIS #etc... my ($self)= shift(@_); my (%args)= @_; #etc...
This way, if you want to change the order of the subs (for organizational purposes) or to move some subs into other files (less likely since this is part of a module, but probable in other types of programs), the comments will always stay with their associated subs.

This will, of course, vary to taste.


How do I love -d? Let me count the ways...

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