README

主页: https://github.com/mfn/php-docblock-normalize

简介

这个库从源文件中提取文档块，并将其中所有的类型描述规范化。也就是说，它们会被转换为完整的符号名，考虑到当前的 namespace 和 use 别名。

要求

PHP 5.6

安装

使用 composer: composer.phar require mfn/docblock-normalize 0.1

示例

sample.php:

<?php namespace Foo;
use Bar as Baz;
/**
 * @param Foo $param1
 * @param Bar $param2
 * @param Baz $param3
 * @param \Foo $param4
 * @param string $param5
 */

解析并输出规范化后的文档块及其类型

$parser = new \Mfn\DocblockNormalize\Parser(
    new \Mfn\DocblockNormalize\TokenParser
);

$docblocks = $parser->parseFile('sample.php');

echo $docblocks[0]->getNormalizedContent();

将返回

/**
 * @param Foo\Foo $param1
 * @param Foo\Bar $param2
 * @param Bar $param3
 * @param Foo $param4
 * @param string $param5
 */

注意： 文档块的 namespace 和 use 语句必须出现在它之前！

注意 2： 规范化还会删除前导反斜杠，这是预期的！

贡献

分叉它，在功能分支上开发，创建拉取请求，做得很好！

没有开发者是孤岛，所以请遵循这些标准

mfn / docblock-normalize

维护者

详细信息

README

简介

要求

安装

示例

贡献