ReflectionClass::getDocComment

(PHP 5, PHP 7)

ReflectionClass::getDocCommentRécupère les commentaires de documentation

Description

public ReflectionClass::getDocComment ( void ) : string

Récupère les commentaires de documentation depuis une classe.

Avertissement

Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Le commentaire de documentation, s'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
*/"

Voir aussi