ReflectionFunctionAbstract::getDocComment

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

ReflectionFunctionAbstract::getDocCommentGets doc comment

Description

public ReflectionFunctionAbstract::getDocComment(): string|false

Get a Doc comment from a function.

Parameters

This function has no parameters.

Return Values

The doc comment if it exists, otherwise false

See Also

add a note add a note

User Contributed Notes 2 notes

up
8
jens dot kohl+php at gmail dot com
11 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
3
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