PHPDoc

Uses your system voice; voice and rate in settings.

Snapshot

≈ 2 min read

Names in other languages

No names in other languages are held for this entry yet.

Article bodies are English and are not machine-translated. A name in another language is not a translation of the article.

PHPDoc is an adaptation of the Javadoc format for the PHP programming language. It is still an informal standard for commenting PHP code, but in the process of being formalized. It allows external document generators like phpDocumentor, which is the de facto standard implementation, to generate documentation, and it 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.

PHPDoc is an adaptation of the Javadoc format for the PHP programming language. It is still an informal standard for commenting PHP code, but in the process of being formalized. It allows external document generators like phpDocumentor, which is the de facto standard implementation, to generate documentation, and it 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. /** * Get all image nodes. * * @param \DOMNode $node The \DOMDocument instance * @param boolean $strict If the document has to be valid * * @return \DOMNode */ public function getImageNodes(\DOMNode $node, $strict = true): \DOMNode { // ... }

See also

phpDocumentor Doxygen Comparison of documentation generators

External links

phpDocumentor.org

Text derived from https://en.wikipedia.org/w/index.php?oldid=1303148246 under CC BY-SA 4.0; modifications have been made.

Sources cited in this revision

1 named source(s) extracted from the cited revision. A source with no author is shown by its publication; nothing is invented.