I personnally prefer to append a short synopsis right after the declaration, so that it appears in the the Ctags and allows me to use it as an usage hint with my editor (Nedit). I also insert the documentation for each function after this synopsis: 
sub addrecord {
    #****m* DataFile/addrecord
    # USAGE
    # $bdlfile->addrecord([field => value, field => value...])
    # Create a record and initialize it according
    # to file format (POF, BDL)
    # RETURNS
    # obj ref DataRecord
    #***
    my $self = shift;

    my %data = @_;
}

[download]
Then in my editor, if I select the word addrecord in my code and hit Ctrl+', I'll see the "USAGE" line.

In reply to Re: Easily catalog subroutines with a synopsis comment by wazoox
in thread Easily catalog subroutines with a synopsis comment by blogical

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.