ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocCommentRecupera los comentarios de documentación

Descripción

public ReflectionClass::getDocComment(): string|false

Recupera los comentarios de documentación desde una clase. Los comentarios de documentación comienzan con /**. Si existen varios comentarios de documentación por encima de la definición de la clase, se tomará el más cercano a la clase.

Parámetros

Esta función no tiene parámetros.

Valores devueltos

El comentario de documentación, si existe, false en caso contrario.

Ejemplos

Ejemplo #1 Ejemplo con ReflectionClass::getDocComment()

<?php
/**
* Una clase de prueba
*
* @param foo bar
* @return baz
*/
class TestClass { }

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

El resultado del ejemplo sería:

string(61) "/**
 * Una clase de prueba
 *
 * @param  foo bar
 * @return baz
 */"

Ver también