array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'reflectionproperty.getdoccomment.php', 1 => 'ReflectionProperty::getDocComment', ), 'up' => array ( 0 => 'class.reflectionproperty.php', 1 => 'ReflectionProperty', ), 'prev' => array ( 0 => 'reflectionproperty.getdefaultvalue.php', 1 => 'ReflectionProperty::getDefaultValue', ), 'next' => array ( 0 => 'reflectionproperty.getmodifiers.php', 1 => 'ReflectionProperty::getModifiers', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/reflection/reflectionproperty/getdoccomment.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
ReflectionProperty::getDocComment — Gets the property doc comment
Gets the doc comment for a property.
Esta função não possui parâmetros.
The doc comment if it exists, otherwise false
.
Exemplo #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());
?>
O exemplo acima produzirá algo semelhante a:
string(53) "/** * @var int The length of the string */"
Exemplo #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;
}
?>
O exemplo acima produzirá:
a: '/** @var string */' b: false