microsoft / microsoft/TypeScript

Support auto-completion for TSDoc

未关闭
#61,592 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

🔍 Search Terms

tsdoc complete

✅ Viability Checklist
⭐ Suggestion

TypeScript currently only supports auto-completion for JSDoc, not TSDoc. For example, there is no intelligent suggestion for @defaultValue.

Image

📃 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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先调查 TypeScript 当前如何提供 JSDoc 自动补全,以及 VSCode 如何使用这些语言服务结果。将该行为与 @defaultValue 等 TSDoc 标签进行比较,并确定预期的语法高亮和补全行为;完成的标准是 TSDoc 注释能够获得智能建议,同时不改变生成的 JavaScript。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
developer-experience, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。