ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocCommentGets doc comments

Descrizione

public ReflectionClass::getDocComment(): string|false

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

Elenco dei parametri

Questa funzione non contiene parametri.

Valori restituiti

The doc comment if it exists, otherwise false.

Esempi

Example #1 ReflectionClass::getDocComment() example

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

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

Il precedente esempio visualizzerà:

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

Vedere anche: