views:

85

answers:

4

I'm new to PHP development, and I'm wondering if the community has any guidelines for inline documentation of code using comments. I'd love something like Python's PEP 257, but I'd settle for a format used by a popular document extraction tool, or even the documentation standard of a popular product.

+4  A: 

Use phpdoc (very similar to javadoc)

Paul Tarjan
+4  A: 

The most widely used form of API documentation for PHP is phpDocumentor. Quite a lot of IDEs are also able to extract information to improve auto-completion hints using phpDocumentor style API docs.

Daniel Egeberg
+3  A: 

PHPdoc is the first thing that comes to mind, take a look at http://www.phpdoc.org/

jordanstephens
A: 

PEAR (PHP Extension and Application Repository) has coding standards that includes a sample file using phpDocumentor, as well as some other useful conventions.

jwhitlock