ReflectionProperty::getDocComment

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

ReflectionProperty::getDocComment — Obtiene los comentarios de documentación de una propiedad

Descripción

public ReflectionProperty::getDocComment(): string

Obtiene los comentarios de documentación de una propiedad.

Parámetros

Esta función no tiene parámetros.

Valores devueltos

Los comentarios de documentación de una propiedad.

Ejemplos

Ejemplo #1 Ejemplo de ReflectionProperty::getDocComment()

<?php
class Str
{
    /**
     * @var int  La longitud del string
     */
    public $length = 5;
}

$prop = new ReflectionProperty('Str', 'length');

var_dump($prop->getDocComment());

?>

El resultado del ejemplo sería algo similar a:

string(51) "/**
     * @var int  La longitud del string
     */"

Ver también

ReflectionProperty::getModifiers() - Obtiene los modificadores
ReflectionProperty::getName() - Obtiene el nombre de la propiedad
ReflectionProperty::getValue() - Obtiene el valor

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

Jim ¶

2 years ago

Unfortunately, inherited doc comments are not supported.

<?php

class A {
    /**
     * @var string
     */
    public string $prop = 'A';
}

class B extends A {
    public string $prop = 'B';
}

$prop = new ReflectionProperty('B', 'prop');
var_dump($prop->getDocComment());

?>

results in FALSE

＋add a note