大网数据广告活动
PHP 语言与运行手册

ReflectionProperty::getDocComment · Gets the property doc comment

· 52CE 我爱测

ReflectionProperty::getDocComment — Gets the property doc comment

ReflectionProperty::getDocComment

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

ReflectionProperty::getDocComment — Gets the property doc comment

说明

public function ReflectionProperty::getDocComment(): string|false

Gets the doc comment for a property.

参数

此函数没有参数。

返回值

The doc comment if it exists, otherwise false.

示例

示例 #1 ReflectionProperty::getDocComment() example

<?php
class Str
{
    /**
     * @var int  The length of the string
     */
    public $length = 5;
}

$prop = new ReflectionProperty('Str', 'length');

var_dump($prop->getDocComment());

?>

以上示例的输出类似于:

string(53) "/**
     * @var int  The length of the string
     */"

示例 #2 Multiple property declarations

If multiple property declarations are preceded by a single doc comment, the doc comment refers to the first property only.

<?php
class Foo
{
    /** @var string */
    public $a, $b;
}
$class = new \ReflectionClass('Foo');
foreach ($class->getProperties() as $property) {
    echo $property->getName() . ': ' . var_export($property->getDocComment(), true) . PHP_EOL;
}
?>

以上示例会输出:

a: '/** @var string */'
b: false

参见

来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
PHP Documentation Group
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 3.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。