Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
For me, the writing of comments is part of the thinking process.

In effect, you are using prose as a form of pseudo-code.

In the past I've tried or used prose, Weiner-Orr Diagrams, Yourdan, SSADM (and derivitives), Jackson, UML, various flavours of Case, and half a dozen variants of pseudo-code to plan code and/or document it. Some with more or less success than others. But in the end, I've found that the language of implemetation is the best pseudo-code (for me!).

I'll often start by sketching out the skeleton of the algorithm in Perl-glish (or C-glish or whatever-glish), and then slowly refine that into code. The advantage is that even at the early stages, I can use the compiler or interpreter to check my progress. When the compiler stops complaining, I'm usually getting close.

it's not the most significant of the comments in a 2,800-odd line module.

Agreed. And it is perhaps a little unfair to pick out so few lines from so many, but to do more entails a lot of work. I did make a start on attempting to re-write the entire module in what I would consider to be a self-documenting style, but then realised it would be equally unfair, as I would be starting from the position of your working example. I also ran out of awake cycles.

The bottom line has to be that there is no 'one right way' to program. But historically, I've found that people tend to be even worse at writing good comments than they are at writing good code. The difference is that I have the compiler to help me sort out the code, but no assistance is available for comments. (Especially a problem for me if they are in German or Italian or Chinese or Spanglish :)

I've personally found it more efficient and effective to put a little more effort into chosing variable and function names that allow the code to be somewhat self-documenting, than to write everything twice. But I realise that that doesn't do it for everyone.

But I do take exception to the implication that my deliberate and considered preference for minimal commenting is born of laziness or a lack of consideration; as nothing could be further from the truth.

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^6: Why no comments? by BrowserUk
in thread Why no comments? by targetsmart

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?

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

    How do I use this? | Other CB clients
    Other Users?
    Others exploiting the Monastery: (9)
    As of 2020-09-22 08:41 GMT
    Find Nodes?
      Voting Booth?
      If at first I donít succeed, I Ö

      Results (128 votes). Check out past polls.