CakeFest 2024: The Official CakePHP Conference

ReflectionFunctionAbstract::getDocComment

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

ReflectionFunctionAbstract::getDocComment获取注释内容

说明

public ReflectionFunctionAbstract::getDocComment(): string|false

获取函数的文档注释。

参数

此函数没有参数。

返回值

如果存在文档注释返回其内容,否则返回 false

参见

add a note

User Contributed Notes 2 notes

up
8
jens dot kohl+php at gmail dot com
12 years ago
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.
up
4
bruno at vault7 dot com
14 years ago
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 */
To Top