Screen Shot of Generated PHP Documentation for Symbol Class
phpDocumentor is a tool to produce documentation for your code to allow other users to learn how to use it without reading the code itself. It is similar to JavaDoc for Java or Doxygen for C / C++. It can freely downloaded from the phpDocumentor site67. Installation and download is done automatically with PEAR using the command
To include source code comments in your phpdoc use two stars in your comments (i.e.
/**). Go to the phpDocumentor installation directory and type
where {SOURCE_PATH} is the full path to your source code and {DOC_PATH} is where you want the PHP documentation to end up. This should produce something like the screenshot below.
There are a number of tags to associate function parameter and other information with the public interface. See the phpDocumentation for details.
There are no user comments.
Please send ideas and opinions by email at alexamies@gmail.com.