README

增加对PHPDoc标准DocBlock标签的支持。

阅读文档页面以获取更多信息。

安装

TypeLang PHPDoc Standard Tags可作为Composer仓库使用，您可以在项目根目录下使用以下命令进行安装

composer require type-lang/phpdoc-standard-tags

简介

增加对包含类型描述的基本注释的支持，这些注释会影响静态分析器的输出。

@method — TypeLang\PHPDoc\Standard\MethodTagFactory
@param — TypeLang\PHPDoc\Standard\ParamTagFactory
@property — TypeLang\PHPDoc\Standard\PropertyTagFactory
@property-read — TypeLang\PHPDoc\Standard\PropertyReadTagFactory
@property-write — TypeLang\PHPDoc\Standard\PropertyWriteTagFactory
@return — TypeLang\PHPDoc\Standard\ReturnTagFactory
@throws — TypeLang\PHPDoc\Standard\ThrowsTagFactory
@var — TypeLang\PHPDoc\Standard\VarTagFactory

使用

use TypeLang\PHPDoc\Parser;
use TypeLang\PHPDoc\Standard;
use TypeLang\PHPDoc\Tag\Factory\TagFactory;

$tags = new TagFactory();

// Add support of standard tags
$tags->register('method', new Standard\MethodTagFactory());
$tags->register('param', new Standard\ParamTagFactory());
$tags->register('property', new Standard\PropertyTagFactory());
$tags->register('property-read', new Standard\PropertyReadTagFactory());
$tags->register('property-write', new Standard\PropertyWriteTagFactory());
$tags->register('return', new Standard\ReturnTagFactory());
$tags->register('throws', new Standard\ThrowsTagFactory());
$tags->register('var', new Standard\VarTagFactory());

$docblock = (new Parser($tags))
    ->parse(<<<'PHPDOC'
        /**
         * @var string example tag.
         */
        PHPDOC);

var_dump($docblock);

type-lang / phpdoc-standard-tags

维护者

详细信息

README

安装

简介

使用