O'Reilly logo

PHP 5 Power Programming by Derick Rethans, Stig Sæther Bakken, Andi Gutmans

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

B.1. Introduction

Besides coding standards, the PEAR project has a standard method of documentation classes and packages. This method makes use of the phpDocumentor tool to generate browseable documentation in HTML from comments in the source of the classes. The official tool to document PEAR classes is phpDocumentor (http://phpdoc.org), which cannot only generate browseable HTML, but also PDF and Docbook XML. It very much resembles JavaDoc (http://java.sun.com/j2se/javadoc/) and has a similar “markup language” for documenting elements. You can install phpDocumentor with the following command:

$ pear install phpDocumentor

There is also an implementation by Alan Knowles at http://www.akbkhome.com/Projects/PHP_CodeDoc/. This appendix introduces ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required