Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

Re: Preferred method of documentation?

by FoxtrotUniform (Prior)
on Oct 05, 2004 at 21:10 UTC ( #396763=note: print w/replies, xml ) Need Help??


in reply to Preferred method of documentation?

POD headers for a module's interface are always nice - describing stuff like assumptions (preconditions) and guarantees (postconditions) of functions. Otherwise, I try to write code that doesn't need much commenting. Well-chosen symbol names, common idioms, and a consistent coding style that errs on the side of whitespace are far more valuable than comments that tell you what each line of code does (or more likely, what it did eight revisions ago when the comment was written).

--
F o x t r o t U n i f o r m
Found a typo in this node? /msg me
% man 3 strfry

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://396763]
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 2020-11-25 03:13 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?