PHP Manual
ReflectionFunctionAbstract
ドキュメントコメントを取得する

ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

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

説明

public function ReflectionFunctionAbstract::getDocComment(): string|false

関数のドキュメントコメントを取得します。

パラメータ

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

戻り値

ドキュメントコメントが存在する場合はそれを返します。それ以外の場合は false を返します。

参考

ReflectionFunctionAbstract::getStartLine() - 開始行番号を取得する

関連キーワード:

ReflectionFunctionAbstract ドキュメントコメント getDocComment getClosureUsedVariables getEndLine 参考 getStartLine 開始行番号

関連する関数・ページ:

reflectionfunctionabstract.getendline reflectionfunctionabstract.getname reflectionfunctionabstract.isdeprecated reflectionfunctionabstract.getfilename reflectionfunctionabstract.getshortname reflectionfunctionabstract.isuserdefined