ReflectionClass::getDocComment
(PHP 5 >= 5.1.0)
ReflectionClass::getDocComment — Récupère les commentaires
Description
public string ReflectionClass::getDocComment
( void
)
Récupère les commentaires depuis une classe.
Avertissement
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.
Exemples
Exemple #1 Exemple avec ReflectionClass::getDocComment()
<?php
/**
* Une classe de test
*
* @param foo bar
* @return baz
*/
class TestClass { }
$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?>
L'exemple ci-dessus va afficher :
string(55) "/** * Une classe de test * * @param foo bar * @return baz */"