downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | conferences | my php.net

search for in the

ReflectionFunctionAbstract::getEndLine> <ReflectionFunctionAbstract::getClosureThis
[edit] Last updated: Fri, 17 May 2013

view this page in

ReflectionFunctionAbstract::getDocComment

(PHP 5 >= 5.1.0)

ReflectionFunctionAbstract::getDocComment — Gets doc comment

Description

public string ReflectionFunctionAbstract::getDocComment ( void )

Get a Doc comment from a function.

Warning

This function is currently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

The doc comment if it exists, otherwise FALSE

See Also



add a note add a note User Contributed Notes ReflectionFunctionAbstract::getDocComment - [2 notes]
up
1
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 */
up
0
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.
add a note add a note

 
show source | credits | stats | sitemap | contact | advertising | mirror sites