Support auto-completion for TSDoc

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

まず、現在 TypeScript が JSDoc の自動補完をどのように提供しているか、また VSCode がそれらの language service の結果をどのように利用しているかを調査します。その動作を @defaultValue などの TSDoc タグと比較し、期待される構文強調表示と補完の動作を判断します。TSDoc コメントがインテリジェントな候補を受け取り、出力される JavaScript を変更しないことが完了の条件です。