ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocComment — 獲取文檔注釋

說明

public ReflectionClass::getDocComment(): string

從一個(gè)類中獲取文檔注釋。

警告

本函數(shù)還未編寫文檔，僅有參數(shù)列表。

參數(shù)

此函數(shù)沒有參數(shù)。

返回值

如果存在則返回文檔注釋，否則返回 false。

范例

示例 #1 ReflectionClass::getDocComment() 例子

<?php
/** 
* A test class
*
* @param  foo bar
* @return baz
*/
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?>

以上例程會(huì)輸出：

string(55) "/** 
* A test class
*
* @param  foo bar
* @return baz
*/"

參見