microsoft / microsoft/TypeScript
JSDoc support for destructured parameters
Open
Nobody has claimed this yet.
Domain: JSDoc
Help Wanted
In Discussion
Suggestion
VS Code Tracked
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 2.0.3
Code
interface Foo {
/**
* A bar value
*/
bar?: string;
}
/**
* A function
*
* @param foo A param
* @param { bar } Another param
* @param bar Another param
*/
function foo(foo: string, { bar }: Foo): void {
bar;
foo;
}
foo('bar', { bar: 'play' });
Expected behavior:
Intellisense for the second argument, or the second argument properties.
Actual behavior:
No way of providing a description for the destructured elements of a destructured parameter.

Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TypeScript example in the issue and reproduce its IntelliSense behavior using the documented JSDoc forms. Trace the language-service handling for destructured parameters; done means descriptions are available for the destructured argument or its properties, with coverage for the reported case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100