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;
}
[download]

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];
}
[download]

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?

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.