microsoft / microsoft/TypeScript

Quick info for parameter redundantly shows @param tag

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

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

Committed Domain: LS: Quick Info Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

TypeScript Version: 3.1.0-dev.20180830

Code

/**
 * @param p
 * Once upon a time there was a parameter named p.
 * P lived in a function called f.
 * Then a big bad wolf came and blew f down.
 */
function f(p: number): void {}

Expected behavior:

Documentation for p is shown only once.

Actual behavior:

Documentation is shown twice -- once as the normal documentation (good), once as documentation for the @param tag which is redundant since we took the documentation from there. This doubles the size of the quick info.

param

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

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

はじめの一歩

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

調査の方向性

TypeScript 3.1.0-dev.20180830 の再現から始めます。JSDoc に @param タグが含まれている場合のパラメーター p の quick info を調べます。現在の出力でパラメーターのドキュメントが重複していることを確認し、その後、他の JSDoc の動作を変更せずに quick info でドキュメントが一度だけ表示されることを検証します。

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

評価

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

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

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