Add a documentation class instead of a formatted string.
还没有人认领这个 Issue。
评估
调研方向
未指定任何文件或测试。首先跟踪函数文档字符串的定义、解析和使用位置；确定当前在该格式中编码的字段。完成的标准是：文档由一个包含描述、返回类型、参数和名称等字段的类表示，所有现有使用方都已更新，并由项目的相关测试覆盖。
由索引模型根据 Issue 内容生成。
描述
CMDHELPER-2915 - Reported by ACzChef
Right now functions have to pass in a string for their docs, that then later gets parsed into usable data.
My suggestion is to have a documentation class where you just define all the fields such as description, return type, arguments, name, etc. and use that instead. It would be cleaner, and less error prone.
- 主要语言
- Java
- 星标
- 128
- 派生
- 70
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
EngineHub/CommandHelper 的其他 Issue
-
discussion wanted documentation
难度 5/5 一周以上 新手友好度 25/100
EngineHub/CommandHelper#1403 ·
-
难度 5/5 一周以上 新手友好度 25/100
EngineHub/CommandHelper#1370 · 1 条评论 ·
-
bug
难度 4/5 3-5 天 新手友好度 35/100
EngineHub/CommandHelper#1354 ·
-
bug
难度 4/5 3-5 天 新手友好度 45/100
EngineHub/CommandHelper#1349 · 3 条评论 ·
-
bug
难度 5/5 一周以上 新手友好度 25/100
EngineHub/CommandHelper#1341 · 2 条评论 ·
查看 EngineHub/CommandHelper 的全部 Issue
相似的 Issue
-
area/plugin
难度 2/5 1-3 小时 新手友好度 75/100
kestra-io/plugin-kestra#190 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
integra-team-red/meet-map#249 ·
-
[Studio][Bug] Cancelled create-user dialog keeps the password and admin switch for the next attempt 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
apache/rocketmq-dashboard#5064 ·