(PHP 5, PHP 7, PHP 8)
ReflectionClass::getDocComment — Возвращает doc-блоки комментариев
Получает doc-блоки из комментариев класса. Doc-блок - это комментарий
начинающийся с /**
, за которым следует пробел.
Если над декларацией класса присутствует несколько 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 */"