array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'es', ), 'this' => array ( 0 => 'reflectionproperty.getdoccomment.php', 1 => 'ReflectionProperty::getDocComment', 2 => 'Recupera el comentario de documentación de una propiedad', ), 'up' => array ( 0 => 'class.reflectionproperty.php', 1 => 'ReflectionProperty', ), 'prev' => array ( 0 => 'reflectionproperty.getdefaultvalue.php', 1 => 'ReflectionProperty::getDefaultValue', ), 'next' => array ( 0 => 'reflectionproperty.gethook.php', 1 => 'ReflectionProperty::getHook', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'es', 'path' => 'reference/reflection/reflectionproperty/getdoccomment.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ReflectionProperty::getDocComment

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

ReflectionProperty::getDocComment — Recupera el comentario de documentación de una propiedad

Descripción

public ReflectionProperty::getDocComment(): string|false

Recupera el comentario de documentación de una propiedad.

Parámetros

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

Valores devueltos

El comentario de documentación si existe, de lo contrario false.

Ejemplos

Ejemplo #1 ReflectionProperty::getDocComment() ejemplo

<?php
class Str
{
/**
* @var int El tamaño de la cadena de caracteres
*/
public $length = 5;
}

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

var_dump($prop->getDocComment());

?>

Resultado del ejemplo anterior es similar a:

string(53) "/**
     * @var int  El tamaño de la cadena de caracteres
     */"

Ejemplo #2 Múltiples declaraciones de propiedades

Si múltiples declaraciones de propiedades son precedidas por un único comentario de documentación, el comentario de documentación hace referencia únicamente a la primera propiedad.

<?php
class Foo
{
/** @var string */
public $a, $b;
}
$class = new \ReflectionClass('Foo');
foreach ($class->getProperties() as $property) {
echo $property->getName() . ': ' . var_export($property->getDocComment(), true) . PHP_EOL;
}
?>

El ejemplo anterior mostrará:

a: '/** @var string */'
b: false

Ver también