Further to Some thoughts around the "is Perl code maintainable" discussion, today I inherited some code written by an external contractor. Here is one of his functions that caught my eye:
sub file_mode {
my ($file) = @_;
if( ! -f $file ) {
return -1;
}
my $dummy;
my $mode;
($dummy,$dummy, $mode, $dummy, $dummy, $dummy, $dummy, $dummy, $dumm
+y,
$dummy, $dummy, $dummy, $dummy) = stat($file);
return $mode;
}
Maybe he thought he was writing in a very "clear" style, but I had to reach for my sunglasses looking through this code. :-)
Assuming that I don't change the (dubious) interface, my instinct would be to write this function as:
sub file_mode {
-f shift or return -1;
return (stat(_))[2];
}
Then I thought, maybe a Perl novice would find the original function easier to understand and maintain. I guess it's like writing, you should write to a level appropriate to your audience. What do you think?
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.