ReflectionClass
PHP Manual

ReflectionClass::getDocComment

(PHP 5 >= 5.1.0)

ReflectionClass::getDocComment — Gets doc comments

説明

public string ReflectionClass::getDocComment ( void )

Gets doc comments from a class.

警告

この関数は、 現在のところ詳細な情報はありません。引数のリストのみが 記述されています。

パラメータ

この関数にはパラメータはありません。

返り値

The doc comment if it exists, otherwise FALSE

例

例1 ReflectionClass::getDocComment example

<?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
PHP Manual