通过 
搜索
搜索szwss / reflection-docblock
1.0.2
2018-12-30 13:06 UTC
Requires
- php: >=5.3.3
Requires (Dev)
- phpunit/phpunit: ~4.0
Suggests
- dflydev/markdown: ~1.0
- erusev/parsedown: ~1.0
This package is auto-updated.
Last update: 2024-09-29 05:28:07 UTC
README
简介
phpDocumentor 的 ReflectionDocBlock 组件提供了一个与 PHPDoc 标准完全兼容的 DocBlock 解析器。
使用此组件，库可以支持通过 DocBlock 或其他方式检索嵌入在 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);