microsoft / microsoft/TypeScript

jsdoc @type is not working properly for some class method variant

オープン
#39,667 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

TypeScript Version: 4.0.0-beta and 3.9.2

Search Terms: jsdoc, type, typedef, class method, typechecking

Code

// @strict: false

/**
 * @typedef {(newNumber: number) => void} SetNumberFunc
 */

class A {
    /**
     * @type {number}
     */
    a = 0;

    constructor() {
        this.a = 0;
    }

    /**
     * @type {SetNumberFunc}
     */
    setAVariant1(newNumber) {
        this.a = newNumber;
    }
}

Expected behavior: The newNumber param should have a number type when hovering on the setAVariant1 method.

Actual behavior: The newNumber param have any type when hovering on the setAVariant1 method.

Playground Link: Playground Link

Related Issues: -

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンクされている TypeScript Playground の再現コードから始め、クラスメソッド setAVariant1 に対する JSDoc @type アノテーションの処理方法を確認してください。newNumber のホバー時の型を期待される number 型と比較し、修正が完了したときに再現コードが any ではなく number を報告することを確認してください。

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

評価

技術スタック
javascript, typescript
領域
compilers
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

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

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