ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0)

ReflectionFunctionAbstract::getDocComment — Gets doc comment

说明

public string ReflectionFunctionAbstract::getDocComment ( void )

Get a Doc comment from a function.

Warning

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

The doc comment if it exists, otherwise FALSE

参见

ReflectionFunctionAbstract::getStartLine() - Gets starting line number

PHP手册 - N: Gets doc comment

用户评论:

jens dot kohl+php at gmail dot com (26-Mar-2012 07: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 (13-Nov-2009 07: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 */