PHPDoc

PHPDoc je standard dokumentování zdrojových kódů pro skriptovací jazyk PHP. PHPDoc je ukládán do komentářů ve zdrojových kódech. Je adaptací Javadoc, který existuje pro jazyk Java. Umožňuje dokumentovat jak objektový tak procedurální kód.

Status

PHPDoc má zatím v současné době status informálního standardu, ale je v procesu formalizace – od 13. srpna 2013 začala skupina PHP Framework Interoperability Group pro PHPDoc psát formální specifikaci (PSR).[1]

Podpora PHPDoc

S PHPDoc spolupracuje phpDocumentor – pomůcka (tool), který na základě PHPDoc dokáže vygenerovat dokumentaci k projektu v různých formátech.

PHPDoc využívají i prostředí jako třeba Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState Komodo Edit a IDE, PHPEdit, Aptana Studio, aby (v různém rozsahu) vylepšila propojení částí kódu v rámci projektu, naznačování typu (type hinting) a ladění.

Komponenty PHPDoc

Odkazy

Reference
  1. https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

Související články

Externí odkazy
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.