A simple suggestion. Turn
sub flip {
into
sub flip { #Flip pancake

A short synopsis comment, appended directly to the declaration line, means you can easily grep through your files and not only see what functions they contain, but also get a synopsis of what each one does.
grep -re 'sub.*{' . will now be even more informative. Hugging the opening brace helps exclude false positives.

Appropriate names and packages only go so far, especially for object libraries where the same function is redefined for different classes. For those, note what distinguishes the function from the others of the same name.

I couldn't recall having seen this suggested anywhere, so I thought I'd toss it out here. This seems like a no-brainer now that one of my projects has a couple hundred functions, scattered across umpteen files and re-use necessitates finding the function in the first place.

"One is enough. If you are acquainted with the principle, what do you care for the myriad instances and applications?"
- Henry David Thoreau, Walden


In reply to 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.