README

简介

phpDocumentor 的 ReflectionDocBlock 组件提供了一个与 PHPDoc 标准完全兼容的 DocBlock 解析器。

使用此组件，库可以支持通过 DocBlocks 提供注释，或者检索 DocBlock 中嵌入的信息。

注意: 这是 phpDocumentor 的核心组件，并且正在不断优化以提高性能。

安装

您可以通过以下方式安装此组件：

使用官方 GitHub 仓库 (https://github.com/phpDocumentor/ReflectionDocBlock)
通过 Composer (https://packagist.org.cn/packages/phpdocumentor/reflection-docblock)

用法

ReflectionDocBlock 组件旨在以与 PHP 自身的 Reflection 扩展 (https://php.ac.cn/manual/en/book.reflection.php) 相同的方式工作。

可以通过实例化 \phpDocumentor\Reflection\DocBlock() 类并传递一个包含 DocBlock（包括星号）的字符串，或者传递一个支持 getDocComment() 方法的对象来启动解析。

具有 getDocComment() 方法的对象示例包括 PHP Reflection 扩展的 ReflectionClass 和 ReflectionMethod 类

示例

$class = new ReflectionClass('MyClass');
$phpdoc = new \phpDocumentor\Reflection\DocBlock($class);

或

$docblock = <<<DOCBLOCK
/**
 * This is a short description.
 *
 * This is a *long* description.
 *
 * @return void
 */
DOCBLOCK;

$phpdoc = new \phpDocumentor\Reflection\DocBlock($docblock);

barryvdh / reflection-docblock

维护者

详细信息

README

简介

安装

用法