(PHP 5, PHP 7)
ReflectionClass::getDocComment — Gets doc comments
public ReflectionClass::getDocComment ( ) : string
Gets doc comments from a class. Doc comments start with /**. If there are multiple doc comments above the class definition, the one closest to the class will be taken.
This function has no parameters.
The doc comment if it exists, otherwise false
Example #1 ReflectionClass::getDocComment() example
<?php
/**
* A test class
*
* @param foo bar
* @return baz
*/
class TestClass { }
$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?> The above example will output:
string(55) "/** * A test class * * @param foo bar * @return baz */"
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/reflectionclass.getdoccomment.php