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.
|
---|
In Section
Meditations