[函数]ReflectionClass::getDocComment()函数—用法及示例

ReflectionClass::getDocComment()函数是用来获取类的文档注释的。它返回一个字符串，该字符串包含了类的文档注释。

用法：

string ReflectionClass::getDocComment ( void )

参数： 该函数没有参数。

返回值： 返回一个包含类的文档注释的字符串，如果没有文档注释则返回 false。

示例： 假设我们有一个名为 MyClass 的类，它有一段文档注释：

/**
 * This is a sample class.
 *
 * @category   PHP
 * @package    MyClass
 * @subpackage Example
 */
class MyClass {
    // class implementation...
}

我们可以使用 ReflectionClass::getDocComment() 函数来获取 MyClass 类的文档注释：

$reflection = new ReflectionClass('MyClass');
$docComment = $reflection->getDocComment();

echo $docComment;

输出结果：

/**
 * This is a sample class.
 *
 * @category   PHP
 * @package    MyClass
 * @subpackage Example
 */

注意：返回的文档注释字符串会包含注释符号（例如 /** 和 */）以及每行开头的空格。如果你想要去掉这些额外的字符，可以使用其他字符串处理函数来处理。