README

解析PHP文档块并使其易于访问。

此库基于反射，结果应大量缓存或仅用于非时间敏感的过程。

安装

运行 composer require crazyfactory/docblocks 将最新版本安装到您的Composer项目中。

您可以将任何格式为doc-block的字符串传递给DocBlock构造函数以对其进行解析。

$dc = new DocBlock('/** myDocBlockString */');

或者，您可以传递任何提供getDocComment()方法的对象，如ReflectionMethod、ReflectionClass等。

$dc = new DocBlock(new \ReflectionClass(MyClass::class));

如果您只关心简单DocBlockParameter-array形式的结果，可以直接使用解析器。

$results = DocBlock::parse($myDocBlockString);