Many modern languages have a built in documentation system which allows
developers to embed documentation into their code. This makes keeping
documentation up to date easier, and simple tools can be created to parse the
documentation out of the code and create docs in formats such as HTML, XML,
etc. PEAR has adopted
as its official inline documentation format.
Development efforts are currently underway to write javadoc parsers in php, and
provide "phpdoc" tools for php developers.
To re-cap, here are the things you need to keep in mind when writing code that
you intend to eventually submit to PEAR.
The following pages were using extensively in the writing of this document.
Special credit must be given to Stig Bakken, who wrote the PEAR documentation
which provided the bulk of the information in this document.