PHP | ReflectionClass getDocComment() Function

The ReflectionClass::getDocComment() function is an inbuilt function in PHP which is used to return the spcified 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:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?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);
?>

chevron_right


Output:

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

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?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);
?>

chevron_right


Output:

bool(false)

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

My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.