Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation

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?

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

How do I use this? | Other CB clients
Other Users?
Others about the Monastery: (1)
As of 2017-03-29 00:49 GMT
Find Nodes?
    Voting Booth?
    Should Pluto Get Its Planethood Back?

    Results (343 votes). Check out past polls.