phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
未关闭
还没有人认领这个 Issue。
- 主要语言
- PHP
- 星标
- 9.4k
- 派生
- 137
- 平均合并
- 4 天 2 小时
- 30 天内合并 PR
- 1
描述
In issue https://github.com/phpDocumentor/phpDocumentor/issues/3378, there was some confusion because the Author tag does not support a description. When the StandardTagFactory encounters a situation where an InvalidTag is generated, it would be nice if it could ask the Tag class what the expected format is and a link to the documentation; and include that in the InvalidTag so that phpDocumentor can provide better error messages in the error report
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先阅读 StandardTagFactory、InvalidTag 以及 issue 中描述的 Tag 类行为,然后查看 issue 3378 中的相关讨论。完成标准是 InvalidTag 实例包含预期的 tag 格式以及指向相关 phpDocumentor 文档的链接,从而让错误报告提供更清晰的指导。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- php
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100