ReflectionProperty::getDocComment

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

ReflectionProperty::getDocComment — Récupère le commentaire de documentation d'une propriété

Description

public ReflectionProperty::getDocComment(): string|false

Récupère le commentaire de documentation d'une propriété.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Le commentaire de documentation s'il existe, sinon false.

Exemples

Exemple #1 ReflectionProperty::getDocComment() example

<?php
class Str
{
    /**
     * @var int  La taille de la chaîne de caractère
     */
    public $length = 5;
}

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

var_dump($prop->getDocComment());

?>

Résultat de l'exemple ci-dessus est similaire à :

string(53) "/**
     * @var int  La taille de la chaîne de caractère
     */"

Exemple #2 Multiple property declarations

Si plusieurs déclaration de propriétés sont précédé d'un unique commentaire de documentation, le commentaire de documentation ne fait référence uniquement à la première propriété.

<?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;
}
?>

L'exemple ci-dessus va afficher :

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

Voir aussi