ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — Obtém comentários doc

Descrição

public ReflectionClass::getDocComment(): string|false

Obtém comentários doc de uma classe. Os comentários doc começam com /**, seguido de espaço em branco. Se houver vários comentários de documentos acima da definição de classe, será pego o mais próximo da classe.

Parâmetros

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

Valor Retornado

O comentário doc se existir, caso contrário false.

Exemplos

Example #1 Exemplo de ReflectionClass::getDocComment()

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

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

O exemplo acima produzirá:

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

Veja Também