Microsoft/TypeScript

JSDoc comment for destructuring param: description text not displayed

Open

#24,746 opened on Jun 7, 2018

View on GitHub
 (25 comments) (32 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: JSDocHelp Wanted

Description

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

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JSDoc basicsTypeScript compiler codebasedestructuring syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue is about JSDoc param descriptions not showing for destructured parameters. Investigate the TypeScript compiler's handling of JSDoc comments, specifically how param tags are matched to function parameters. Look at the related issue #19645 for context. Check the comments in this issue for any discussed approaches. Focus on the parsing logic in the checker or binder that processes JSDoc param tags for destructured parameters.