Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
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.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://915947]
help
Chatterbox?
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (8)
As of 2017-11-24 19:16 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    In order to be able to say "I know Perl", you must have:













    Results (353 votes). Check out past polls.

    Notices?