Jump to content

PHPDoc

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by SUM1 (talk | contribs) at 03:45, 31 May 2020 (Adding short description: "Documentation generator for PHP based on Javadoc" (Shortdesc helper)). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

PHPDoc is an adaptation of Javadoc for the PHP programming language. It is still an informal standard for commenting PHP code, but it is in the process of being formalized.[1] It allows external document generators like phpDocumentor, which is the de facto standard implementation,[1] to generate documentation of APIs and helps some IDEs such as Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState Komodo Edit and IDE, PHPEdit and Aptana Studio to interpret variable types and other ambiguities in the loosely typed language and to provide improved code completion, type hinting and debugging.

PHPDoc supports documentation of both object-oriented and procedural code.

On August 13, 2013 the PHP Framework Interoperability Group began writing a formal specification (PSR) for PHPDoc.[1]

See also

References

  1. ^ a b c PHP-FIG: PSR Working Draft - https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md
Retrieved from "https://en.wikipedia.org/w/index.php?title=PHPDoc&oldid=959898103"