scaleupstack / annotations
经典 DocBlock 风格注释和扩展多行声明的解析器。
v1.2.0
2019-10-26 22:07 UTC
Requires
- php: >=7.2.0
- scaleupstack/assert: ^1.
Requires (Dev)
- phpunit/phpunit: ^7
This package is auto-updated.
Last update: 2024-08-27 18:02:36 UTC
README
关于
此库允许读取经典 DocBlock 风格的注释,包括扩展的多行声明。
内置的支持注释集可以通过项目特定的扩展轻松扩展。
安装
使用 Composer 安装此库
$ composer require scaleupstack/annotations
介绍
此库尚未进行文档编制。但也许 scaleupstack/metadata 可以帮助您了解如何使用它。
待办事项:待办
当前状态
此库的目的是特殊设计的。它将在 scaleupstack/metadata 和 scaleupstack/easy-object 的背景下发展。
这导致了一些已知限制,但这些限制对于此目的不是高优先级的。
-
例如,在
@var
中不支持所有允许的类名(例如,UTF-8 特殊字符)。 -
仅内置了 phpDocumentor 注释标签的子集。
-
一些限制可能非常严格。
如果您缺少任何内容,请随时联系我,或创建一个 pull request。
目前实现的内置注释如下
-
@method
-
@property-read
-
@var
所有其他注释都表示为 UnknownAnnotation
。
贡献
感谢您想为 ScaleUpStack/Annotations 做贡献。
许可
请查看此包根目录中的 LICENSE.md。
版权
德国 ScaleUpVentures Gmbh
托马斯·宁宁格 thomas.nunninger@scaleupventures.com
www.scaleupventures.com