PhPDocs - Documentation App for PHP Code
We have started to use PHPDocumentor to create JavaDocs-eqsue documentation of our PHP code.
The application itself is very easy to modify in the event that you want to alter the stylesheets to make the documents be more cohesive with your site, or if you are colorblind and want to get away from the tragic red-on-blue color scheme that is the current default.
Some tips:
When documenting parameters using the @param tag format your documents as follows:
@param type $name description to follow
@param type $name2 description to follow
When documenting return type, you can either leave the return type blank (exclude the tag) and you will have a return type of void, or you can document your non-void return type as follows:
@return string description to follow
in my examples, “description to follow” is where I go into detail about the significance of the parameter or return object.
Also, be sure to format your comments like so:
/**
* @param type $name
* @param type $name2
* @return type
*/
