(PHP 5 >= 5.1.0, PHP 7, PHP 8)
ReflectionProperty::getDocComment — Recupera el comentario de documentación de una propiedad
Recupera el comentario de documentación de una propiedad.
Esta función no tiene parámetros.
El comentario de documentación si existe, de lo contrario false.
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());
?>El resultado del ejemplo sería algo 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 resultado del ejemplo sería:
a: '/** @var string */' b: false
