PHP | ReflectionProperty getDocComment() Function
The ReflectionProperty::getDocComment() function is an inbuilt function in PHP which is used to return the doc comment of the specified property.
Syntax:
string ReflectionProperty::getDocComment ( void )
Parameters: This function does not accept any parameters.
Return Value: This function returns the doc comment of the specified property.
Below programs illustrate the ReflectionProperty::getDocComment() function in PHP:
Program 1:
<?php // Initializing a user-defined class Company class Company { /** * @Below is the Size of w3wiki String */ public $SizeOfw3wiki = 13; /** * @Below is the Size of GFG String */ public $SizeOfGFG = 3; } // Using ReflectionProperty $A = new ReflectionProperty( 'Company' , 'SizeOfw3wiki' ); $B = new ReflectionProperty( 'Company' , 'SizeOfGFG' ); // Calling the getDocComment() function $C = $A ->getDocComment(); $D = $B ->getDocComment(); // Getting the doc comment of the specified property var_dump( $C ); var_dump( $D ); ?> |
Output:
string(63) "/** * @Below is the Size of w3wiki String */" string(53) "/** * @Below is the Size of GFG String */"
Program 2:
<?php // Initializing some user-defined classes class Department1 { /** * @Below is the Size of HR String */ public $SizeOfHR = 2; } class Department2 { /** * @Below is the Size of Coding String */ public $SizeOfCoding = 6; } class Department3 { /** * @Below is the Size of Marketing String */ public $SizeOfMarketing = 9; } // Using ReflectionProperty over above classes $A = new ReflectionProperty( 'Department1' , 'SizeOfHR' ); $B = new ReflectionProperty( 'Department2' , 'SizeOfCoding' ); $C = new ReflectionProperty( 'Department3' , 'SizeOfMarketing' ); // Calling the getDocComment() function $D = $A ->getDocComment(); $E = $B ->getDocComment(); $F = $C ->getDocComment(); // Getting the doc comments of the specified properties var_dump( $D ); var_dump( $E ); var_dump( $F ); ?> |
Output:
string(52) "/** * @Below is the Size of HR String */" string(56) "/** * @Below is the Size of Coding String */" string(59) "/** * @Below is the Size of Marketing String */"
Reference: https://www.php.net/manual/en/reflectionproperty.getdoccomment.php
Contact Us