PHP | ReflectionProperty getDocComment()函数介绍

ReflectionProperty::getDocComment()是PHP Reflection API提供的函数之一。它用于获取某个属性（property）文档注释（doc comment）信息。

使用方法

<?php
class ExampleClass {
    /** 
     * This is an example property
     *
     * @var int $exampleVar 
     **/
    public $exampleVar = 123;
}

$reflection = new ReflectionClass('ExampleClass');
$property = $reflection->getProperty('exampleVar');
$docComment = $property->getDocComment();
echo $docComment;
?>

上述代码会输出以下内容：

/**
 * This is an example property
 *
 * @var int $exampleVar 
 **/

返回值

ReflectionProperty::getDocComment()返回一个字符串，其中包含属性的完整文档注释（doc comment）。 如果属性没有文档注释，则返回false。

示例

示例1

<?php
class ExampleClass {
    /** 
     * This is an example property
     *
     * @var int $exampleVar 
     **/
    public $exampleVar = 123;
}

$reflection = new ReflectionClass('ExampleClass');
$property = $reflection->getProperty('exampleVar');
$docComment = $property->getDocComment();
echo $docComment;
?>

输出：

/**
 * This is an example property
 *
 * @var int $exampleVar 
 **/

示例2

<?php
class ExampleClass {
    public $exampleVar = 123;
}

$reflection = new ReflectionClass('ExampleClass');
$property = $reflection->getProperty('exampleVar');
$docComment = $property->getDocComment();
var_dump($docComment);
?>

输出：

bool(false)

注意事项

• 该函数返回值包含注释符号/**和*/。
• 在获取属性的文档注释之前，必须先通过ReflectionClass或ReflectionObject获取对象的反射类/对象，并使用ReflectionClass::getProperty()或ReflectionObject::getProperty()获取属性的反射对象。