microsoft / microsoft/TypeScript
Suggestion: Generate doc comments in emitted JS
未关闭
还没有人认领这个 Issue。
Needs Proposal
Suggestion
VS Code Tracked
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.4k
- 平均合并
- 1 天 19 小时
- 30 天内合并 PR
- 117
描述
Support some level of automatically generating doc comments for non-TypeScript JavaScript consumers.
Need more details on what exactly people would like to see generated.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
没有指定文件、测试或入口点，而且 issue 表示仍需定义所需的生成注释。首先明确 JavaScript 使用者需要哪些文档注释，以及预期的输出内容。完成的标准是确定一致同意的范围，并有覆盖所指定生成注释的测试。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, typescript
- 领域
- compilers, documentation
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100