Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
what I thought I'd done was to describe in broad terms what I consider to be the attributes of good commenting,

Your opening line is:

"It is indeed a sad state of affairs when programmers fail to properly comment as they write code."

And that sets the tone for the entire post.

For the rest. When I encounter modules that contain that much verbiage I often just delete it without reading it.

Especially when I encounter comments like

# Reverse sort the set and partitions and insert sums

To "document":

@$rs = reverse sort numerically @$rs ; @a = ($sa, reverse sort numerically @a) ; @b = ($sb, reverse sort numerically @b) ;
  • Reverse: This keyword precedes all three sorts.

    It is redundant.

  • sort: as is this.
  • the set: if @$rs was @$set, this word becomes redundant.
  • and partitons: Ditto these, if @a and @b where @partA and @partB.

    Especially if the sub were called partitionShuffled() rather than hack_C.

  • And insert sums: Ditto if $sa and $sb where $sumA & $sumB.

Three lines of verbiage (including 2 blanks) mostly redundant. And completely redundant if the documentation is placed in the only verifiable content of the file--the code.

And

# Done -- return partitins in required order

to "document"

if ($a[0] >= $b[0]) { return (\@a, \@b) ; } else { return (\@b, \@a) ; } ; } ;
  • Done --: The end of the subroutine and your done. No shit Sherlock!
  • return: And your going to return something. Cool.

    The fact that you use return in the code (twice) is a pretty clear clue.

  • partitins: @partA & partB would be so much better.
  • in required order: Required for what? By whom?

    You mean partition A then partition B if the sum of A is greater or equal to the sum of B. Or vice versa otherwise.

  • (And what's with that floating semicolon after the subroutine?)

Again, mostly redundant, with the code being far clearer than the "documentation".

And the whole lot would be clearer still (and far more efficient to boot), written as:

# Sort the callers array in-place @$set = sort{ $b<=>$a } @$set; return $sumA >= $sumB ? ([ $sumA, sort{ $b<=>$a } @partA ], [ $sumB, sort{ $b<=>$a } + @partB ]) : ([ $sumB, sort{ $b<=>$a } @partB ], [ $sumA, sort{ $b<=>$a } + @partA ]) ; }

Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
"Science is about questioning the status quo. Questioning authority".
In the absence of evidence, opinion is indistinguishable from prejudice.

In reply to Re^4: Why no comments? by BrowserUk
in thread Why no comments? by targetsmart

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, 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, 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.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others examining the Monastery: (7)
    As of 2019-11-20 19:46 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      Strict and warnings: which comes first?



      Results (101 votes). Check out past polls.

      Notices?