microsoft / microsoft/TypeScript

Hover documentation for typescript uses jsdoc rules and not tsdoc

オープン
#61,603 コメント 8 件 リアクション 5 件 担当者 0 名 GitHub で見る
Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

- VS Code Version: 1.99.3
17baf841131aa23349f217ca7c570c76ee87b957
x64
- OS Version: N/A (happens on all)

Steps to Reproduce:

1. Write some typescript code and use the syntax required by tsdoc
2. Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
3. Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support

Examples:

Thinking that the [mandatory hyphen](https://tsdoc.org/pages/tags/param/) after a parameter name is a markdown hint for a bullet point
![Image](https://github.com/user-attachments/assets/bbe5ae33-38e6-42dc-a00e-98e163313c33)

Not recognizing the `@defaultValue` tag, and assuming `@default` and `@defaultvalue`

![Image](https://github.com/user-attachments/assets/9c34bfaf-e412-429b-9d27-6ee7b7c19107)

Not understanding [`@remarks`](https://tsdoc.org/pages/tags/remarks/), which is marked as [core](https://tsdoc.org/pages/spec/standardization_groups/), meaning you are expected to recognize it

Not providing hover for `@typeParam`
 ![Image](https://github.com/user-attachments/assets/82c94ee5-44a5-47fb-a7c6-e42740205fd0)

(The list goes on...)

Also, this last remark isn't a bug, but it would be really, _really_ great if you would support [`@inheritDoc`](https://tsdoc.org/pages/tags/inheritdoc/) for hover.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、VS Code 1.99.3 で一覧にある TSDoc の例を再現し、ホバーテキストとハイライトをリンク先の TSDoc ルールと比較します。次に、JSDoc タグを処理する TypeScript のホバードキュメントの経路を追跡し、その後、@param、@defaultValue、@remarks、@typeParam などの主要なタグが期待されるフォーマットで認識されることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
developer-experience
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。