PHP 7.1.0 Release Candidate 3 Released

ReflectionProperty::getDocComment

(PHP 5 >= 5.1.0, PHP 7)

ReflectionProperty::getDocCommentGets 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

add a note add a note

User Contributed Notes

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