Recupera los comentarios de documentación

# ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — Recupera los comentarios de documentación

### Descripción

public function ReflectionClass::getDocComment(): string|false

Recupera los comentarios de documentación desde una clase. Los comentarios de documentación comienzan con `/**`. Si existen varios comentarios de documentación por encima de la definición de la clase, se tomará el más cercano a la clase.

### Parámetros

Esta función no contiene ningún parámetro.

### Valores devueltos

El comentario de documentación, si existe, `false` en caso contrario.

### Ejemplos

Ejemplo #1 Ejemplo con ReflectionClass::getDocComment()

    <?php
    /**
     * Una clase de prueba
     *
     * @param  foo bar
     * @return baz
     */
    class TestClass { }

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

El ejemplo anterior mostrará:

    string(61) "/**
     * Una clase de prueba
     *
     * @param  foo bar
     * @return baz
     */"

### Ver también

- ReflectionClass::getName() - Obtiene el nombre de la clase

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open