mpociot / reflection-docblock

维护者

详细信息

github.com/mpociot/reflection-docblock

源代码

问题

安装次数: 9,099,142

依赖关系: 56

建议者: 0

安全性: 0

星标: 86

关注者: 3

分支: 4

开放性问题: 1

1.0.1 2016-06-20 20:53 UTC

Requires

  • php: >=5.3.3

Requires (Dev)

Suggests

MIT c8b2e2b1f5cebbb06e2b5ccbf2958f2198867587

  • Mike van Riel <mike.vanriel.woop@naenius.com>

This package is auto-updated.

Last update: 2024-08-24 10:07:11 UTC

README

简介

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

使用此组件，库可以通过 DocBlocks 或其他方式提供对注解的支持，或检索 DocBlock 中嵌入的信息。

注意: 这是 phpDocumentor 的核心组件，并持续优化性能。

安装

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

用法

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);