phpDocumentor / phpDocumentor/ReflectionDocBlock
Support Annotation-style tags
未关闭
还没有人认领这个 Issue。
- 主要语言
- PHP
- 星标
- 9.4k
- 派生
- 137
- 平均合并
- 4 天 2 小时
- 30 天内合并 PR
- 1
描述
Tags like @Route("/anonymization_preset", name="anonymization_preset_") show the part between parenthesis as part of the description. It would be more convenient to make this a first-class citizen as now this conflicts with the rule that descriptions may be parsed as Markdown documents.
See https://github.com/phpDocumentor/phpDocumentor/issues/2081 for more information
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先阅读此 issue 以及链接的 phpDocumentor issue 2081,以明确预期的 Annotation-style 标签语法,以及它应如何区别于 Markdown 描述。然后定位 ReflectionDocBlock 中标签解析和描述处理的入口点;当示例 annotation 被作为 first-class tag 处理,而不是作为描述的一部分进行解析,并且新行为得到覆盖时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- php
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100