Some of my routines have long names, but they are not usually public API's. They are used internally there to give context when they are being called. I also try to use names so that they work well with variables that are being passed to help give context.

Here is an example that I used in reference to a baseball game I am writing.

#################################################
sub __playball_game_over {
    my $self   = shift;
    my $result = shift;

    return if $self->__playball_inning_get < 9;

    if ( $self->__playball_team_on('offense')->get_id eq
         $self->away_team->get_id) {
        return if $result->run_scored;
        return 1
            if $self->__playball_score_for('home_team') >
               $self->__playball_score_for('away_team');
    }
    elsif ($result->run_scored) {
        return 1
            if $self->__playball_score_for('home_team') >
               $self->__playball_score_for('away_team');
    }
    else {
        return 1
            if $self->__playball_score_for('home_team') !=
               $self->__playball_score_for('away_team');
    }
    return;
}

[download]

I try my best to avoid long names, but I will use them to clarify my code. Code should be written like it is going to be read.

In reply to Re^3: Easily catalog subroutines with a synopsis comment by Herkum
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.