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

ReflectionClass::getDocComment · 获取文档注释

· 52CE 我爱测

从类中获取文档注释。文档注释以 /** 开头,后跟空格。 如果类定义上方有多个文档注释,则采用最接近该类的注释。

ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — 获取文档注释

说明

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

从类中获取文档注释。文档注释以 /** 开头,后跟空格。 如果类定义上方有多个文档注释,则采用最接近该类的注释。

参数

此函数没有参数。

返回值

如果存在则返回文档注释,否则返回 false。

示例

示例 #1 ReflectionClass::getDocComment() 示例

<?php
/**
 * A test class
 *
 * @param  foo bar
 * @return baz
 */
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment());
?>

以上示例会输出:

string(61) "/** 
 * A test class
 *
 * @param  foo bar
 * @return baz
 */"

参见

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

资料来源与适用范围

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

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

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