Question

Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output?

Was it helpful?

Solution

I´ll go for doxygen too.

Here are several reasons :

  • compatible with phpdoc tags and other popular ones : it´s interoperable
  • works with various programming languages : a better time investment
  • there is alternative syntaxes : can choose the commenting style that suit you
  • very efficient with advanced formating / tagging / metadata
  • there is a GUI that is not linked to any IDE and an eclipse plugin as well

And still free, multiplatform, and open source :-)

It´s easy to learn, but harder that phpdoc because a lot richer.

OTHER TIPS

You could try DocBlox; which is intended to be an alternative for phpDocumentor but with support for additional features of which full PHP 5.3 support is one. An additional benefit is that is it quite fast and uses relatively little memory.

You can read more on http://www.docblox-project.org or see a demo at http://demo.docblox-project.org/default

Another option other than phpDocumentor is Doxygen documentation with PHP support.

Doxygen (www.doxygen.org).

ApiGen

http://apigen.org/

ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits.

DocBlox

http://www.docblox-project.org/

PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration.

able to fully parse and transform Zend Framework 2

I am using Doxygen too - you get used to the various keywords really fast - they are kind of self-explaining. ;)

RubyDoc is nice too, I espcially like they layout of the rdocs.

Doctrine uses PHPDoctor, which appears to work well with 5.3 in my tests.

http://peej.github.com/phpdoctor/#download

I've not used it with PHP, but doxygen claims to support the language.

If you need to document code for PHP 5.3+, eg. if it uses namespaces Ted Kulp's fork of PHPDoctor might be your answer.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top