ReflectionClass::getDocComment
ReflectionClass::getDocComment
(PHP 5 >= 5.1.0, PHP 7)
ReflectionClass::getDocComment — Gets doc comments
Description
public string ReflectionClass::getDocComment ( void )
Gets doc comments from a class.
Warning
This function is currently not documented; only its argument list is available.
Parameters
This function has no parameters.
Return Values
The doc comment if it exists, otherwise FALSE
Examples
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 */"
See Also
- ReflectionClass::getName() - Gets class name
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/reflectionclass.getdoccomment.php
