ReflectionProperty::getDocComment
ReflectionProperty::getDocComment
(PHP 5 >= 5.1.0, PHP 7)
ReflectionProperty::getDocComment — Gets the property doc comment
Description
public string ReflectionProperty::getDocComment ( void )
Gets the doc comment for a property.
Parameters
This function has no parameters.
Return Values
The property doc comment.
Examples
Example #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());
?> The above example will output something similar to:
string(53) "/**
* @var int The length of the string
*/"
See Also
- ReflectionProperty::getModifiers() - Gets the property modifiers
- ReflectionProperty::getName() - Gets property name
- ReflectionProperty::getValue() - Gets value
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/reflectionproperty.getdoccomment.php
