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

ReflectionProperty::getDocCommentGets the property doc comment


public ReflectionProperty::getDocComment(): string|false

Gets the doc comment for a property.


This function has no parameters.

Return Values

The doc comment if it exists, otherwise false.


Example #1 ReflectionProperty::getDocComment() example

class Str
     * @var int  The length of the string
public $length 5;

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



The above example will output something similar to:

string(53) "/**
     * @var int  The length of the string

Example #2 Multiple property declarations

If multiple property declarations are preceeded by a single doc comment, the doc comment refers to the first property only.

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

The above example will output:

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

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top