ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — 获取文档注释

说明

public ReflectionClass::getDocComment ( ) : string

从一个类中获取文档注释。

警告

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

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

范例

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

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

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

以上例程会输出：

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

参见