ReflectionProperty::getDocComment
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
ReflectionProperty::getDocComment — Gets the property doc comment
Beschreibung
public ReflectionProperty::getDocComment(): string|false
Gets the doc comment for a property.
Parameter-Liste
Diese Funktion besitzt keine Parameter.
Rückgabewerte
The doc comment if it exists, otherwise false.
Beispiele
Beispiel #1 ReflectionProperty::getDocComment() example
<?php
class Str
{
/**
* @var int The length of the string
*/
public $length = 5;
}
$prop = new ReflectionProperty('Str', 'length');
var_dump($prop->getDocComment());
?>
Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:
string(53) "/**
* @var int The length of the string
*/"
Beispiel #2 Multiple property declarations
If multiple property declarations are preceeded by a single doc comment, the doc comment refers to the first property only.
<?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;
}
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
a: '/** @var string */' b: false
Siehe auch
- ReflectionProperty::getModifiers() - Gets the property modifiers
- ReflectionProperty::getName() - Gets property name
- ReflectionProperty::getValue() - Gets value
Hier Kannst Du einen Kommentar verfassen
Es sind noch keine Kommentare vorhanden.
