PHP 5.6.0beta1 released


(PHP 5 >= 5.1.0)

ReflectionClass::getDocCommentRécupère les commentaires


public string ReflectionClass::getDocComment ( void )

Récupère les commentaires depuis une classe.


Cette fonction n'est pas documentée et seule la liste des arguments est disponible.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Le commentaire, si il existe, FALSE sinon.


Exemple #1 Exemple avec ReflectionClass::getDocComment()

* Une classe de test
* @param  foo bar
* @return baz
class TestClass { }

$rc = new ReflectionClass('TestClass'); 

L'exemple ci-dessus va afficher :

string(55) "/** 
* Une classe de test
* @param  foo bar
* @return baz

Voir aussi

add a note add a note

User Contributed Notes 2 notes

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.
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.
To Top