获取文档注释

# 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
     */"

### 参见

- ReflectionClass::getName() - 获取类名

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open