News Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Liip Blog:
PHPDoc Compilers and the @inheritdoc
July 26, 2011 @ 09:29:06

On the Liip blog there's a new post that compares some of the popular PHPDocumentor-formatted comments parsers. They're looking specifically at the support for interfaces, not just the usual classes and methods.

The interfaces define the standard and are extensively documented. The implementation was built by copying the interfaces and implementing the methods. Now we have the documentation comments duplicated, which is a pain to maintain if we clarify or change anything in the interfaces documentation. [...] In PHP, there is a couple of doc compilers. While they basically all follow the same syntax as Java uses, none of them gets everything right unfortunately.

The four covered are PhpDoctor, DocBlox, PHPDoc and Doxygen. They look at things like namespace support, the inheritance information they generate and if it correctly uses the "@inheritDoc" tagging functionality.

0 comments voice your opinion now!
inheritdoc phpdocumentor standard library phpdoctor docblox phpdoc doxygen


blog comments powered by Disqus

Similar Posts

Nefarious Designs Blog: On Coding Standards

Evolt.org: PHP Localization with TMX standard

MegaLeecher.net: Decoding CAPTCHA using PHP | Hypertext Preprocessor

PHPWomen.org: Best Practices Thread

Tobias Schlitt's Blog: PHP Documentor for VIM documented


Community Events





Don't see your event here?
Let us know!


api introduction bugfix language install tips symfony package opinion zendserver release library podcast series interview community framework laravel deployment unittest

All content copyright, 2014 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework