24

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?

Alive to die - Anant
  • 70,531
  • 10
  • 51
  • 98
Edward Tanguay
  • 189,012
  • 314
  • 712
  • 1,047
  • Please precise 'richer output'. Otherwise it's difficult to give precise answer. – Paweł Hajdan Sep 19 '08 at 13:20
  • 1
    What problems are you having with 5.3? (Also, running the doc generator via the command line version of PHP (with a custom ini with a larger memory allocation if necessary) would probably resolve the memory issue. – John Parker Jan 21 '10 at 20:37
  • From what I understand of the situation, phpDocumentor does not support namespaces. The memory issue is one I'm sure they've tried, though I could double check. – user256162 Jan 21 '10 at 21:51
  • @user256162 It works with PHP 5.3, but all classes go to default package. I expected it to treat namespaces like packages. Anyone managed to do this? – umpirsky Feb 03 '11 at 22:11

9 Answers9

19

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.

Bite code
  • 578,959
  • 113
  • 301
  • 329
8

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

mvriel
  • 674
  • 6
  • 6
7

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

albert
  • 8,285
  • 3
  • 19
  • 32
Yada
  • 30,349
  • 24
  • 103
  • 144
5

Doxygen (www.doxygen.org).

Polsonby
  • 22,825
  • 19
  • 59
  • 74
Roel
  • 19,338
  • 6
  • 61
  • 90
3

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

albert
  • 8,285
  • 3
  • 19
  • 32
GreenMatt
  • 18,244
  • 7
  • 53
  • 79
3

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

M A Hossain Tonu
  • 1,437
  • 15
  • 14
  • http://apigen.org is lovley and I've been using that now. It supports namespaces and has a lovely code output too. Here's my ant config for it: ` ` – Jujhar Singh Jul 29 '12 at 19:06
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.

unexist
  • 2,518
  • 23
  • 27
2

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

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

KevBurnsJr
  • 4,869
  • 2
  • 25
  • 16
1

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.

Peter O.
  • 32,158
  • 14
  • 82
  • 96
h00ligan
  • 1,471
  • 9
  • 17