Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

Re^3: The art of comments: (rave from the grave)

by halley (Prior)
on Jul 07, 2005 at 13:53 UTC ( #473099=note: print w/ replies, xml ) Need Help??


in reply to Re^2: The art of comments: (rave from the grave)
in thread The art of comments: (rave from the grave)

(1) You asked for examples of what we think are good comments; you didn't specify that they had to be live code published on the web but I guess that's all you wanted to see. With your followup, your tone sounds more like "show me that all the wisdom isn't just hot air, prove to me that people really bother to comment properly."

(2) The pseudocode example I gave was directly taken from my real code; the actual code between the comments would not have contributed much to the discussion so I returned it to pseudocode form. Sorry, but 99.99% of the code I write is not published on the web, nor will it be.

(3) You're welcome to browse http://search.cpan.org/ under Authors: HALLEY for three really small examples. Fair warning: these examples are so small and simple that the comments are almost entirely POD, not # form. Perhaps someday the example I illustrated will be published, since it's a meaty and tightly-knit component library of over 30 packages, and it has a LOT of weird code that needs commenting.

--
[ e d @ h a l l e y . c c ]


Comment on Re^3: The art of comments: (rave from the grave)
Download Code
Re^4: The art of comments: (rave from the grave)
by Anonymous Monk on Jul 07, 2005 at 17:03 UTC
    ...I wonder if anyone would care to link to one or two examples...
    Actually, the OP was quite clear that he wanted links to examples, not inlined ones.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://473099]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others cooling their heels in the Monastery: (6)
As of 2014-08-28 04:38 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (256 votes), past polls