PHP Documentor
- 1. THE PHP DOCUMENTOR Presented by : - Arunima Goswami
- 2. INDEX What & Why of Documentation ? What , Why and How of PHP Documenter ? Example
- 3. Documentation : A bird’s viewpoint WHY Now a standard Required in teams Assisting new team members Display how code is designed WHY NOT Grueling process Time consuming
- 4. What Is Documentation ? Recording in a particular format information that describes the code/product. Documentation is often divided into the following categories: Installation Reference tutorial
- 5. WHAT DOES ONE WANT ? End User Instruction-style writing Interface information only Examples and tutorials Developer How program elements interact Where action occurs How to extend the code
- 6. What is PHP Documenter ? A PHP code document generation tool which is a stand-alone professional documenter that is written in PHP designed to easily and efficiently generate PHP code documents in HTML from PHP project source code and/or external documentation.
- 7. WHY ? output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook very fast fully customizable output with Smarty-based templates recognizes JavaDoc-style documentation with special tags customized for PHP 4 automatic linking, class inheritance diagrams and intelligent override
- 8. Cont’d … customizable source code highlighting parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation linking between external manual and API documentation is possible at the sub-section level in all output formats user .ini files can be used to control output, multiple outputs can be generated at once
- 9. Installation Download from Pear.Php.net or Sourceforge.net Have Apache and PHP installed If using pear then simply run: $ pear install PhpDocumentor you can then browse to http://localhost/pear/PhpDocumentor to have access to the web interface. Else you can use third party tools such as ZEND studio which has php documenter in it
- 10. EXAMPLE
- 11. THANK YOU