ReflectionClass::getDocComment

(PHP 5 >= 5.1.0)

ReflectionClass::getDocComment — Gets doc comments

Descrição

public string ReflectionClass::getDocComment ( void )

Gets doc comments from a class.

Warning

Esta função não está documentada; somente a lista de argumentos está disponível.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

The doc comment if it exists, otherwise FALSE

Exemplos

Example #1 ReflectionClass::getDocComment() example

<?php
/** 
* A test class
*
* @param  foo bar
* @return baz
*/
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?>

O exemplo acima irá imprimir:

string(55) "/** 
* A test class
*
* @param  foo bar
* @return baz
*/"

Veja Também