Microsoft/TypeScript

JSDoc comment for destructuring param: description text not displayed

開放

#24,746 建立於 2018年6月7日

 (25 則留言) (32 個反應) (0 位負責人)TypeScript (13,395 個分叉)batch import
BugDomain: JSDocHelp Wanted

倉庫指標

星標
 (108,860 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南