PHP 8.2.0 Beta 3 available for testing

ReflectionProperty::getDocComment

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

ReflectionProperty::getDocCommentRé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

add a note

User Contributed Notes 1 note

up
0
Jim
2 months 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
To Top