ReflectionClass::getDocComment
PHP function
Edit on GitHub ✎
(PHP 5, PHP 7, PHP 8)
Gets doc comments
Description
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.
Parameters Parameters
Return Values
The doc comment if it exists, otherwise false.
Examples
ReflectionClass::getDocComment example
php
<?php
/**
* A test class
*
* @param foo bar
* @return baz
*/
class TestClass { }
$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment());
?>The above example will output:
output
string(60) "/**
* A test class
*
* @param foo bar
* @return baz
*/"See Also
ReflectionClass::getName