在 PHP 中,您可以使用反射类(ReflectionClass)来获取类的元数据,包括注释。以下是一个示例,展示了如何使用 ReflectionClass 获取类的注释:
<?php
/**
* 这是一个示例类
*/
class ExampleClass
{
/**
* 这是一个示例方法
* @param int $a
* @param int $b
* @return int
*/
public function exampleMethod(int $a, int $b): int
{
return $a + $b;
}
}
// 创建一个 ReflectionClass 对象
$reflectionClass = new ReflectionClass('ExampleClass');
// 获取类文档注释
$classDocComment = $reflectionClass->getDocComment();
echo "Class Doc Comment:\n{$classDocComment}\n";
// 获取方法文档注释
$methodDocComments = $reflectionClass->getMethod('exampleMethod')->getDocComment();
echo "Method Doc Comment:\n{$methodDocComments}\n";
输出:
Class Doc Comment:
/**
* 这是一个示例类
*/
Method Doc Comment:
/**
* 这是一个示例方法
* @param int $a
* @param int $b
* @return int
*/
在这个示例中,我们首先创建了一个名为 ExampleClass
的类,并为其添加了一些文档注释。然后,我们使用 ReflectionClass
类来获取类的文档注释和方法的文档注释。