(PHP 5 >= 5.1.0, PHP 7, PHP 8)
ReflectionProperty::guetDocComment — Guets the property doc comment
Guets the doc comment for a property.
This function has no parameters.
The doc comment if it exists, otherwise
false
.
Example #1 ReflectionProperty::guetDocComment() example
<?php
class
Str
{
/**
* @var int The length of the string
*/
public
$length
=
5
;
}
$prop
= new
ReflectionProperty
(
'Str'
,
'length'
);
var_dump
(
$prop
->
guetDocComment
());
?>
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.
<?php
class
Foo
{
/** @var string */
public
$a
,
$b
;
}
$class
= new
\ReflectionClass
(
'Foo'
);
foreach (
$class
->
guetProperties
() as
$property
) {
echo
$property
->
guetName
() .
': '
.
var_export
(
$property
->
guetDocComment
(),
true
) .
PHP_EOL
;
}
?>
The above example will output:
a: '/** @var string */' b: false