PHPDoc
PHPDocは、 Javadoc形式をPHP プログラミング言語向けに改良したものです。PHPコードにコメントするための非公式な標準規格としてはまだ存在していますが、現在、公式化の過程にあります。[1] PHPDocは、事実上の標準実装であるphpDocumentor [1]などの外部ドキュメントジェネレータによるドキュメント生成を可能にし、Zend Studio、NetBeans、JetBrains PhpStorm、ActiveState Komodo EditおよびIDE、PHPEdit、Aptana StudioなどのIDEが、緩く型付けされた言語における変数の型やその他の曖昧さを解釈し、コード補完、型ヒント、デバッグを向上させるのに役立ちます。
PHPDoc は、オブジェクト指向コードと手続き型コードの両方のドキュメントをサポートします。
2013年8月13日、PHPフレームワーク相互運用性グループはPHPDocの正式な仕様（PSR）の作成を開始しました。[1]
例
/** * すべての画像ノードを取得します。* * @param \DOMNode $node \DOMDocument インスタンス* @param boolean $strict ドキュメントが有効である必要がある場合* * @return \DOMNode */ public function getImageNodes ( \DOMNode $node , $strict = true ) : \DOMNode { // ... }参照
参考文献
- ^ abc PHP-FIG: PSR ワーキングドラフト - https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md
外部リンク
- phpDocumentor.org
