第11章 高度なプログラミング / 第5回 模擬試験
PHPのドキュメンテーションコメントに関する次の記述のうち、正しいものはどれか。
ドキュメンテーションコメントは`/** ... */`の形式で記述し、関数やクラスの説明を記述できる。
正解
ドキュメンテーションコメントは実行時のパフォーマンスを大幅に向上させる構文である。
ドキュメンテーションコメントは`//`を3つ重ねて記述する。
ドキュメンテーションコメントは、PHPの構文エラーを自動的に修正する機能である。
解説
ドキュメンテーションコメント(DocBlock)は`/** ... */`という形式で記述し、関数・メソッド・クラスなどの直前に置いて、その役割や引数・戻り値の説明(`@param`, `@return`などのタグを使う)を書くためのコメントです。
他の選択肢が誤りである理由は次の通りです。
・ドキュメンテーションコメントは単なるコメントであり、PHPの実行時パフォーマンスには影響しません。
・ドキュメンテーションコメントは、通常のブロックコメントと同じ`/** ... */`の形式です。「`//`を3つ重ねる」という記法はPHPには存在しません。
・ドキュメンテーションコメントは構文エラーを修正する機能ではなく、あくまで人間(やIDE、静的解析ツール)向けの説明文書です。
例:
```
/**
* 2つの数値を加算する
*
* @param int $a
* @param int $b
* @return int
*/
function add(int $a, int $b): int {
return $a + $b;
}
```
(参照: 独習PHP 第4版 第11章 高度なプログラミング 11.3節 ドキュメンテーションコメント p.617〜620)