(PHP 5 >= 5.1.0)

ReflectionClass::getDocCommentObtener los comentarios de documentación


public string ReflectionClass::getDocComment ( void )

Obtiene los comentarios de documentación de una clase.


Esta función no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


Esta función no tiene parámetros.

Valores devueltos

Los comentarios de documentación, o FALSE si no existiera.


Ejemplo #1 Ejemplo de ReflectionClass::getDocComment()

* Clase de prueba
* @param  foo bar
* @return baz
class ClaseDePrueba { }

$rc = new ReflectionClass('ClaseDePrueba');

El resultado del ejemplo sería:

string(55) "/** 
* Clase de prueba
* @param  foo bar
* @return baz

Ver también

add a note add a note

User Contributed Notes 2 notes

uramihsayibok, gmail, com
3 years ago
According to what I can find in the PHP (5.3.2) source code, getDocComment will return the doc comment as the parser found it.
The doc comment (T_DOC_COMMENT) must begin with a /** - that's two asterisks, not one. The comment continues until the first */. A normal multi-line comment /*...*/ (T_COMMENT) does not count as a doc comment.

The doc comment itself includes those five characters, so <?php substr($doccomment, 3, -2) ?> will get you what's inside. A call to trim() after is recommended.
joe dot scylla at gmail dot com
4 years ago
If you're using a bytecode cache like eAccelerator this method will return FALSE even if there is a properly formatted Docblock. It looks like the information required by this method gets stripped out by the bytecode cache.
To Top