PHP Reflection类获取类和方法的头部注释

作者:IT技术圈子 浏览量:361   更新于 2023-09-30 23:45 标签:

PHP Reflection类获取类和方法的头部注释,示例代码如下

<?php

namespace test\reflectTest;

require_once '../function.php';

/**
 * 利用反射类获取注释:类和方法
 *
 * @package test\reflectTest
 */
class getDocument
{
    /**
     * 返回一个字符串
     *
     * @return string
     */
    public function execute() {
        return 'getDocument';
    }
}

/** @var getDocument $obj */
$obj = new getDocument();

$reflection = new \ReflectionClass($obj);// 反射类,获取类的相关信息

// 获取类的注释
$class_comment = $reflection->getDocComment();

// 获取方法的注释
$method_comment = $reflection->getMethod('execute')->getDocComment();


dump($class_comment);
dump($method_comment);


// 结果:

string(89) "/**
 * 利用反射类获取注释:类和方法
 *
 * @package test\reflectTest
 */"
string(73) "/**
     * 返回一个字符串
     *
     * @return string
     */"