ReflectionFunctionAbstract::getDocComment

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

ReflectionFunctionAbstract::getDocComment — 获取注释内容

说明

public ReflectionFunctionAbstract::getDocComment ( ) : string

获取函数的注释文本

Warning

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

参数

此函数没有参数。

返回值

如果存在注释文本返回其内容，否则返回 false

参见

ReflectionFunctionAbstract::getStartLine() - 获取开始行号

User Contributed Notes

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 */