ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0)

ReflectionFunctionAbstract::getDocComment — Récupère un commentaire

Description

public string ReflectionFunctionAbstract::getDocComment ( void )

Récupère un commentaire depuis une fonction.

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, s'il existe, FALSE sinon.

Voir aussi

ReflectionFunctionAbstract::getStartLine() - Récupère le numéro de ligne de départ

add a note User Contributed Notes ReflectionFunctionAbstract::getDocComment - [2 notes]

down

jens dot kohl+php at gmail dot com ¶

1 year ago


Beware when you try to use the getDocComment() methods with eAccelerator turned on. eAccelerator »optimizes« your code in a way that it removes any comments from your source. So at runtime you're not able to get any comments and therefor getDocComments return false.

down

bruno at vault7 dot com ¶

3 years ago


In order to retrieve a comment with this method, the comment must be imediately before the class, function or method, start with /** and end with */

add a note