perlancar:

In the case of input validation, I usually let the variable name express the intent then validate the value into submission before doing the work:

sub frob_file {
    my $frobbable_filename = shift;
    die "Error" if !-e $frobbable_filename or -d $frobbable_filename;
    die "Nope!" if not_frobbable($filename);

    ... frob file ...
}

[download]

In other cases when the variable isn't so clear but it will be clear shortly, I'll often use $t or $tmp for the placeholder. Then I'll give it a name or pass the data off to a better-named thing:

sub zap_the_thing {
    my $t = shift;
    my @files_to_zap;

    if (-d $t) {
       zap_dir($t);
    }
    else {
       push @files_to_zap, $t;
    }

    ... yadda ...

    zap_files(@files_to_zap);
}

[download]

I don't think $t or $tmp is a great name, but finding good names is hard. I use it so that I can look at it and dispose of it ASAP.

Frequently I find I can't name something well the first time I encounter or use it. So I come up with my best guess of the name and use it. Then, when it feels like the name is wrong, and I find it doesn't fit, I do one of two things: If I have a better name in mind, I'll rename it. Sometimes, though, I can't think of a better name, so I instead give it a prefix of 'z' to "call it out". That way, when I revisit the code, I know I need a better name. Not perfect, not even good, but it usually gets me by. Yet I still wind up with stuff like:

# ?NEED GOOD NAME?
# If a group (Row, Col, Blk) has only one slot for a particular value,
# solve that cell.
sub solve_v_in_only_one_cell_in_R_C_B {
    my ($self, $GEN) = @_;

[download]

an atrocity which came directly off my screen from last nights session.

...roboticus

When your only tool is a hammer, all problems look like your thumb.

In reply to Re^3: Coding style: truth of variable name by roboticus
in thread Coding style: truth of variable name by perlancar

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.