microsoft / microsoft/TypeScript
Support auto-completion for TSDoc
未关闭
还没有人认领这个 Issue。
Awaiting More Feedback
Suggestion
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
🔍 Search Terms
tsdoc complete
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
TypeScript currently only supports auto-completion for JSDoc, not TSDoc. For example, there is no intelligent suggestion for @defaultValue.
📃 Motivating Example
If TSDoc is the recommended commenting standard for TypeScript, then it should natively support intelligent suggestions and syntax highlighting for TSDoc.
💻 Use Cases
Writing comments using TSDoc syntax in VSCode.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先调查 TypeScript 当前如何提供 JSDoc 自动补全,以及 VSCode 如何使用这些语言服务结果。将该行为与 @defaultValue 等 TSDoc 标签进行比较,并确定预期的语法高亮和补全行为;完成的标准是 TSDoc 注释能够获得智能建议,同时不改变生成的 JavaScript。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- developer-experience, tooling
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100