ReflectionProperty::getDocComment()函数—用法及示例

函数名称：ReflectionProperty::getDocComment()

适用版本：PHP 5 >= 5.1.0, PHP 7

函数说明：ReflectionProperty::getDocComment() 方法用于获取类属性的文档注释。

语法：public string ReflectionProperty::getDocComment ( void )

参数： 无

返回值： 返回一个字符串，表示类属性的文档注释。如果不存在文档注释，则返回空字符串。

示例：

class MyClass {
    /**
     * @var string This is a sample property.
     */
    public $sampleProperty;
}

$reflectionClass = new ReflectionClass('MyClass');
$reflectionProperty = $reflectionClass->getProperty('sampleProperty');

$docComment = $reflectionProperty->getDocComment();
echo $docComment;

输出：

/**
 * @var string This is a sample property.
 */

解释：

在上面的示例中，我们定义了一个名为MyClass的类，其中包含了一个名为sampleProperty的公共属性，并给它添加了一个文档注释@var string This is a sample property.。

然后，我们使用ReflectionClass类创建了一个$reflectionClass对象，用于反射MyClass类。接下来，我们使用ReflectionClass::getProperty()方法获取sampleProperty属性的反射对象$reflectionProperty。

最后，我们使用ReflectionProperty::getDocComment()方法获取sampleProperty属性的文档注释，并将其输出到屏幕上。在这个例子中，输出的结果就是属性的文档注释`/**

• @var string This is a sample property. */`。