microsoft / microsoft/TypeScript

JSDoc comment for destructuring param: description text not displayed

オープン
#24,746 コメント 25 件 リアクション 32 件 担当者 0 名 GitHub で見る

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

Bug Domain: JSDoc Help Wanted
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

TypeScript Version:
2.9

Search Terms:
JSDoc destructuring param

Code

/**
 * @param {Object} arg
 * @param {number} arg.id - This param description won't show up
 */
function foo({ id }) {}

Expected behavior:
In VSCode 1.24.0, when typing foo(, IntelliSense should display the full param description, including its type and text.

Actual behavior:
The type is displayed ("number"), but not the text ("This param description won't show up"):
image

Related Issues:
https://github.com/Microsoft/TypeScript/issues/19645

Additional remark
When omitting the {Object} line, the param text shows up correctly:
image

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

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

はじめの一歩

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

調査の方向性

まず、VSCode 1.24.0 で TypeScript 2.9 を使って例を再現し、{Object} 行を省略したケースと比較してください。コンテキストについては、関連する issue #19645 を読んでください。foo( に対する IntelliSense に、分割代入されたパラメーターの型と説明テキストが表示されれば完了です。

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

評価

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

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

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