Возвращает doc-блоки комментариев


(PHP 5 >= 5.1.0)

ReflectionClass::getDocCommentВозвращает doc-блоки комментариев

Описание

public string ReflectionClass::getDocComment ( void )

Возвращает doc-блоки комментариев класса.

Внимание

К настоящему времени эта функция еще не была документирована; для ознакомления доступен только список аргументов.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

doc-блок комментариев, если он существует, в противном случае FALSE

Примеры

Пример #1 Пример использования ReflectionClass::getDocComment()

<?php
/** 
* Тестовый класс
*
* @param  foo bar
* @return baz
*/
class TestClass { }

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

Результат выполнения данного примера:

 string(55) "/**  * Тестовый класс * * @param  foo bar * @return baz */" 

Смотрите также