Microsoft/TypeScript
JSDoc comment for destructuring param: description text not displayed
オープン
#24,746 opened on 2018/06/07
BugDomain: JSDocHelp Wanted
Repository metrics
- Stars
- (108,860 個のスター)
- PR merge metrics
- (PR metrics pending)
説明
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"):
Related Issues: https://github.com/Microsoft/TypeScript/issues/19645
Additional remark
When omitting the {Object} line, the param text shows up correctly:
