Open In App

PHP | ReflectionClass getDocComment() Function

Last Updated : 30 Jul, 2021
Comments
Improve
Suggest changes
Like Article
Like
Report

The ReflectionClass::getDocComment() function is an inbuilt function in PHP which is used to return the specified doc comments if it exists, otherwise returns false.
 

Syntax: 

string ReflectionClass::getDocComment( void )


Parameters: This function does not accept any parameters.
Return Value: This function returns the specified doc comments if it exists, otherwise returns false.
 

Below programs illustrate the ReflectionClass::getDocComment() function in PHP:
Program 1: 

php
<?php
 
// Below is the doc comments 
/** 
* Below program is
* about getting the
* doc comments.
*/ 
// Defining a class named as Departments
class Departments {}
 
// Using ReflectionClass over the class Departments
$ReflectionClass = new ReflectionClass('Departments');
 
// Calling getDocComment() functions
$A = $ReflectionClass->getDocComment();
 
// Getting specified doc comments
var_dump($A);
?>

Output: 
string(66) "/** 
* Below program is
* about getting the
* doc comments.
*/"

 

Program 2: 

php
<?php
 
// Defining a class named as Departments
class Departments {}
 
// Using ReflectionClass over the class Departments
$ReflectionClass = new ReflectionClass('Departments');
 
// Calling getDocComment() functions
$A = $ReflectionClass->getDocComment();
 
// Getting specified doc comments
var_dump($A);
?>

Output: 
bool(false)

 

Reference: https://www.php.net/manual/en/reflectionclass.getdoccomment.php


Next Article

Similar Reads