ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0)

ReflectionFunctionAbstract::getDocComment — Gets doc comment

Beschreibung

public string ReflectionFunctionAbstract::getDocComment ( void )

Get a Doc comment from a function.

Warnung

Diese Funktion ist bis jetzt nicht dokumentiert. Es steht nur die Liste der Argumente zur Verfügung.

Parameter-Liste

Diese Funktion hat keine Parameter.

Rückgabewerte

The doc comment if it exists, otherwise FALSE

Siehe auch

ReflectionFunctionAbstract::getStartLine() - Gets starting line number

add a note User Contributed Notes ReflectionFunctionAbstract::getDocComment

jens dot kohl+php at gmail dot com 26-Mar-2012 11:19


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.

bruno at vault7 dot com 12-Nov-2009 11:09


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