ReflectionFunctionAbstract::getDocComment
(PHP 5 >= 5.1.0)
ReflectionFunctionAbstract::getDocComment — Получает документируемый комментарий
Описание
public string ReflectionFunctionAbstract::getDocComment
( void
)
Получает документируемый комментарий из описания функции.
Внимание
К настоящему времени эта функция еще не была документирована; для ознакомления доступен только список аргументов.
Список параметров
У этой функции нет параметров.
Возвращаемые значения
Комментарий, если он есть, FALSE в противном случае.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения, относящиеся к переменным и типам
- Reflection
- Функция ReflectionFunctionAbstract::__clone() - Копирующий конструктор
- Функция ReflectionFunctionAbstract::getClosureScopeClass() - Returns the scope associated to the closure
- Функция ReflectionFunctionAbstract::getClosureThis() - Возвращает указатель this замыкания
- Функция ReflectionFunctionAbstract::getDocComment() - Получает документируемый комментарий
- Функция ReflectionFunctionAbstract::getEndLine() - Получает номер строки завершения описания функции
- Функция ReflectionFunctionAbstract::getExtension() - Получает информацию о расширении
- Функция ReflectionFunctionAbstract::getExtensionName() - Получение имени расширения
- Функция ReflectionFunctionAbstract::getFileName() - Получает имя файла
- Функция ReflectionFunctionAbstract::getName() - Получает имя функции
- Функция ReflectionFunctionAbstract::getNamespaceName() - Получение имени пространства имен
- Функция ReflectionFunctionAbstract::getNumberOfParameters() - Получает количество аргументов
- Функция ReflectionFunctionAbstract::getNumberOfRequiredParameters() - Получает количество обязательных аргументов
- Функция ReflectionFunctionAbstract::getParameters() - Получает аргументы
- ReflectionFunctionAbstract::getReturnType
- Функция ReflectionFunctionAbstract::getShortName() - Получает короткое имя функции
- Функция ReflectionFunctionAbstract::getStartLine() - Получает начальный номер строки
- Функция ReflectionFunctionAbstract::getStaticVariables() - Получает статические переменные
- ReflectionFunctionAbstract::hasReturnType
- Функция ReflectionFunctionAbstract::inNamespace() - Проверяет, находится ли функция в пространстве имен
- Функция ReflectionFunctionAbstract::isClosure() - Проверяет, является ли функция замыканием
- Функция ReflectionFunctionAbstract::isDeprecated() - Проверяет, является ли функция устаревшей
- Функция ReflectionFunctionAbstract::isGenerator() - Returns whether this function is a generator
- Функция ReflectionFunctionAbstract::isInternal() - Проверяет, является ли функция внутренней
- Функция ReflectionFunctionAbstract::isUserDefined() - Проверяет, является ли функция определенной пользователем
- ReflectionFunctionAbstract::isVariadic
- Функция ReflectionFunctionAbstract::returnsReference() - Проверяет, что функция возвращает ссылку
- Функция ReflectionFunctionAbstract::__toString() - Преобразование в строку
Коментарии
In order to retrieve a comment with this method, the comment must be imediately before the class, function or method, start with /** and end with */Beware when you try to use the getDocComment() methods with eAccelerator turned on. eAccelerator »optimizes« your code in a way that it removes any comments from your source. So at runtime you're not able to get any comments and therefor getDocComments return false.