ReflectionProperty::getDocComment()
(PHP 5 >= 5.1.0, PHP 7)
Gets the property doc comment
说明
public ReflectionProperty::getDocComment(void) : string
Gets the doc comment for a property.
参数
此函数没有参数。
返回值
The property doc comment.
范例
Example #1ReflectionProperty::getDocComment()example
<?php class Str { /** * @var int The length of the string */ public $length = 5; } $prop = new ReflectionProperty('Str', 'length'); var_dump($prop->getDocComment()); ?>
以上例程的输出类似于:
string(53) "/** * @var int The length of the string */"
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; } ?>
以上例程会输出:
a: '/** @var string */' b: false
参见
- ReflectionProperty::getModifiers() Gets the property modifiers
- ReflectionProperty::getName() Gets property name
- ReflectionProperty::getValue() Gets value