microsoft / microsoft/TypeScript
Implemented method JSDocs not behaving correctly for @param
オープン
まだ誰も着手していません。
Bug
Domain: JSDoc
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
TS Template added by @mjbvz
TypeScript Version: 4.0.0-dev.20200518
Search Terms
- completionEntryDetails
- jsdoc
- tags
- VSCode Version: 1.45.0
- OS Version: Ubuntu 20.04
Steps to Reproduce:
- Add JSDocs to an interface, and implement that interface in a class
interface Sample {
/**
* Does some important work
* @param name Name of employee working
* @param age Age of employee
*/
doWork(name: string, age: number): void;
}
let s: Sample;
class Concrete implements Sample {
doWork(name: string, age: number) {
// Nothing to do
}
}
let c: Concrete;
- Attempt to access intellisense for the class, and notice the @param information has not been picked up from the interface.

Does this issue occur when all extensions are disabled?: Yes
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
インターフェイスとそれを実装するクラスの例を再現し、その後、クラスメソッドに対して IntelliSense が使用する completionEntryDetails パスを調査します。インターフェイスに対して表示されるパラメーターのドキュメントと、実装に対して表示されるものを比較します。実装の補完候補にインターフェイスの @param の説明が含まれ、報告された例がカバーされていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100