What is the status of PHPDoc?

Question

I had never been interested in documenting my code before, but recently I started working on an open source project, and a need arose. Obviously, the "weapon of choice" is PHPDoc, but ...

I could not find any specifications for the PHPDoc standard. There is a wikipedia entry listing some properties, and there is a phpDocumentor project that supposedly has a more extensive dictionary, but what puzzles me is where is the final PHPDoc guide? Is there one standard, or does it depend on all these many phpDocumentor fakes, to extend the "PHPDoc" standard (if any) to whatever they see fit.

Assuming phpDocumentor is the place where the PHPDoc standard is created and maintained, everything looks rather bleak since the project website has been dead for almost 4 years. And what puzzles me even more is that about a month ago the version " 1.4.4 unexpectedly appeared from the dead on the Pear site phpDocumentor.

I know that there are much more intelligent and knowledgeable guys here, so I would like to know. What is a deal with PHPDoc. Is there a single body that creates a standard? How reliable is it? Is there a future, or are we dealing with zombies, and all hope is lost ...

Thanks, Ivo

Answer 1

This question is already a little old, but for information I must add that DocBlox has been merged with PhpDocumentor.

The phpDocumentor 2 declaration is a merge of the old (phpDocumentor) and the new (DocBlox).

With the first alpha version of phpDocumentor (2.0.0a1), the new Responsive Template by default supports the new page layout, as well as useful layout improvements that the original DocBlox templates (which remain available) over the old phpDocumentor templates (which are removed from the old phpDocumentor). Explore this new template at http://demo.phpdoc.org/Responsive/index.html .

=> http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

PHPDoc returns to action. =)

Answer 2

According to Wikipedia, he is dead .

The specifications for PhpDoc tags that were specified in the documentation for PhpDocumentor. But, as I said, he is dead. Since DocBlox seems to fill the void left by PhpDocumentor, I would recommend using the DocBlox documentation as a basis for how you make your PhpDoc comments.

I hope Netbeans 7.1 introduces DocBlox support because it is much better. He knows PHP 5.3 and is actively supported.

Answer 3

As of August 2013, the PHP Framework Interoperability Group began writing an official specification (PSR) for PHPDoc. Proposed standard for PHPDoc, current PSR5 project: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

The current project is updating the specification for the PHP 5.3+ address, as well as other changes that have occurred. I believe that this standard for php comments will be adopted based on several doc generators.