ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

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

Описание

public ReflectionClass::getDocComment(): string|false

Получает 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
*/"

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