ReflectionClass::getDocComment

(PHP 5, PHP 7)

ReflectionClass::getDocComment — Gets doc comments

Descrierea

public ReflectionClass::getDocComment ( void ) : string

Gets doc comments from a class. Doc comments start with /**. If there are multiple doc comments above the class definition, the one closest to the class will be taken.

Parametri

Această funcție nu are parametri.

Valorile întoarse

The doc comment if it exists, otherwise FALSE

Exemple

Example #1 ReflectionClass::getDocComment() example

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

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

Exemplul de mai sus va afișa:

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

A se vedea și