README

PHP Docblock 解析器和生成器。一个用于读取和写入 Docblock 的 API。

警告：从版本 4.0 开始，库已迁移到 phpowermove 组织，命名空间为 phpowermove\docblock。

安装

通过 Composer 安装

composer require phpowermove/docblock

a) 简单

use phpowermove\docblock\Docblock;

$docblock = new Docblock();

b) 从字符串创建

use phpowermove\docblock\Docblock;

$docblock = new Docblock('/**
 * Short Description.
 *
 * Long Description.
 *
 * @author gossi
 */');

c) 从反射创建

use phpowermove\docblock\Docblock;

$docblock = new Docblock(new \ReflectionClass('MyClass'));

获取标签

$tags = $docblock->getTags();

按名称获取标签

$tags = $docblock->getTags('author');

添加标签

use phpowermove\docblock\tags\AuthorTag;

$author = new AuthorTag();
$author->setName('gossi');
$docblock->appendTag($author);

或使用流畅 API

use phpowermove\docblock\tags\AuthorTag;

$docblock->appendTag(AuthorTag::create()
	->setName('gossi')
);

检查标签是否存在

$docblock->hasTag('author');

调用 toString()

$docblock->toString();

或在写入上下文中，魔法 __toString() 会处理它

echo $docblock;

请随意分叉并提交一个 pull request（不要忘记测试），我很乐意合并。