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

Re: Documentation: POD vs Comments

by JavaFan (Canon)
on Jul 21, 2011 at 18:12 UTC ( #915947=note: print w/ replies, xml ) Need Help??


in reply to Documentation: POD vs Comments

Hmmm, manual pages have existed for many decades, yet C programmers still comment their code.

POD and comments have totally different audiences: POD is to generate manual pages from - the audience is the user of the code. Comments are there for the programmer - the audience is the person maintaining the code.

Not being aware of the difference makes bad documentation. For the user, or the maintainer, and very likely for both.


Comment on Re: Documentation: POD vs Comments

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (6)
As of 2014-07-26 06:38 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (175 votes), past polls