ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — ドキュメントコメントを取得する

説明

public ReflectionClass::getDocComment(): string|false

クラスのドキュメントコメントを取得します。 ドキュメントコメントは、 /** で始まり、 ホワイトスペースがその後に続きます。 クラス定義に複数のドキュメントコメントが存在した場合、 クラスに一番近いコメントを取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

ドキュメントコメントが存在すればそれを返します。存在しなければ false を返します。

例

例1 ReflectionClass::getDocComment() の例

<?php
/**
* A test class
*
* @param foo bar
* @return baz
*/
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment());
?>

上の例の出力は以下となります。

string(61) "/** 
 * A test class
 *
 * @param  foo bar
 * @return baz
 */"

参考