microsoft / microsoft/TypeScript

JSDoc doesn't show param info for parameter properties using @param

オープン
#36,356 コメント 5 件 リアクション 11 件 担当者 1 名 GitHub で見る

@rachelgshaffer がすでに取り組んでいます。

2020年6月25日 から。

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

説明

TS Template added by @mjbvz

TypeScript Version: 3.8.0-beta

Search Terms

  • quickInfo
  • jsdoc

  • VSCode Version: 1.41.1 (Commit: 26076a4de974ead31f97692a0d32f90d735645c0)
  • OS Version: MacOS Catalina 10.15 (19A602)

Steps to Reproduce:

  1. Create a function with a single parameter
  2. Add documentation to it with object parameter properties contained.
/**
 * Shows a dialog to the user with the given title, content, and performs the onAcceptClick
 * on the accept button press
 *
 * @param {Object} payload - The dialog information to show the user
 * @param {string} payload.title - Title of dialog
 * @param {string} payload.content - Content of the dialog
 * @param {string} [payload.acceptText=null] - Text shown on the accept button
 * @param {Function} [payload.onAcceptClick=null] - Action performed when accept is clicked
 * @param {string} [payload.cancelText=null] - Text shown on the cancel button
 * @param {Function} [payload.onCancelClick=null] - Action performed when cancel is clicked
 */
export const showDialog = (payload) => ({
  type: constants.UPDATE_DIALOG,
  payload,
})

All the parameters show for the method signatures but none of the inner parameter descriptions show. e.g. payload.cancelText does not show the text "Text shown on the cancel button" in the hover event dialog.

Sample

Note as well. Following the sytax defined here the default values do not show anywhere within the pop up. (I can make a separate issue if needed)

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

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

はじめの一歩

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

評価

この issue はまだ評価されていません。

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

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