(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocCommentGets doc comments


public ReflectionClass::getDocComment(): string|false

Gets doc comments from a class. Doc comments start with /**, followed by whitespace. If there are multiple doc comments above the class definition, the one closest to the class will be taken.


This function has no parameters.

Return Values

The doc comment if it exists, otherwise false.


Example #1 ReflectionClass::getDocComment() example

* A test class
* @param foo bar
* @return baz
class TestClass { }

$rc = new ReflectionClass('TestClass');

The above example will output:

string(61) "/** 
 * A test class
 * @param  foo bar
 * @return baz

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top