Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

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

by displeaser (Hermit)
on Jul 07, 2005 at 12:51 UTC ( [id://473078]=note: print w/replies, xml ) Need Help??


in reply to The art of comments: (rave from the grave)

Hi,

one piece of code on which I liked because imho it was well commented is config::inifiles: http://search.cpan.org/src/GCARLS/Config-IniFiles-2.39/IniFiles.pm.

I liked it because it,
A: dosnt over comment so can see whats happening and it's not obscured.
B: Most of the comments explain something either the code or pod dosnt, ie it compliments it and explains whats happening further.

Just my 2 cents

Displeaser.
  • Comment on Re: The art of comments: (rave from the grave)

Replies are listed 'Best First'.
Re^2: The art of comments: (rave from the grave)
by BrowserUk (Patriarch) on Jul 07, 2005 at 13:03 UTC

    Thankyou for the link!

    I know thankyous can be frowned upon, but in this case as you're the first person to actually do what I was hoping for, I think it is warrented. :)


    Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
    Lingua non convalesco, consenesco et abolesco. -- Rule 1 has a caveat! -- Who broke the cabal?
    "Science is about questioning the status quo. Questioning authority".
    The "good enough" maybe good enough for the now, and perfection maybe unobtainable, but that should not preclude us from striving for perfection, when time, circumstance or desire allow.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others admiring the Monastery: (5)
As of 2024-04-25 12:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found