ドキュメントコメントを取得する

# ReflectionClass::getDocComment

(PHP 5, PHP 7)

ReflectionClass::getDocComment — ドキュメントコメントを取得する

### 説明

public ReflectionClass::getDocComment ( void ) : 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
    */"

### 参考

- ReflectionClass::getName() - クラスの名前を取得する