ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0)

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

説明

public string ReflectionFunctionAbstract::getDocComment ( void )

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

警告

この関数は、現在のところ詳細な情報はありません。引数のリストのみが記述されています。

パラメータ

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

返り値

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

参考

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

add a note User Contributed Notes ReflectionFunctionAbstract::getDocComment

jens dot kohl+php at gmail dot com 26-Mar-2012 11:19


Beware when you try to use the getDocComment() methods with eAccelerator turned on. eAccelerator »optimizes« your code in a way that it removes any comments from your source. So at runtime you're not able to get any comments and therefor getDocComments return false.

bruno at vault7 dot com 12-Nov-2009 11:09


In order to retrieve a comment with this method, the comment must be imediately before the class, function or method, start with /** and end with */

add a note