microsoft / microsoft/TypeScript
Intellisense should inherit documentation for Interfaces.
オープン
まだ誰も着手していません。
Experience Enhancement
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.
Below is a picture of an example:

You can see that the description is properly shown however the param and returns tag is not.
What is expected:

コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ドキュメントと @param/@returns タグを含むインターフェイスで報告された IntelliSense の動作を再現し、その後、実装されたインターフェイスメンバーにドキュメントを提供する TypeScript の言語サービスパスを調べます。実装側のメンバーに、継承されたパラメータータグと戻り値タグとともにインターフェイスの説明が表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- developer-experience
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100