microsoft / microsoft/TypeScript
support destructuring parameter @param tag in tsdoc
Open
Nobody has claimed this yet.
Experience Enhancement
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
tsdoc rule:
https://github.com/microsoft/tsdoc/issues/186
vscode issue:
https://github.com/microsoft/vscode/issues/80368
example:
/**
*
* @param bar - the bar parameter
* @param a - the first parameter
* @param b - the second parameter
* @param c - the third parameter
* @returns the return value
*/
function foo(bar: string, {
a,
b,
c
}:{
a: string,
b: number,
c: string
}) {
return bar + a;
}
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 destructuring example and review the linked TSDoc and VS Code issues to understand the expected @param behavior. Locate the TypeScript documentation or language-service handling for destructured parameters, then add coverage showing that a, b, and c receive the intended parameter documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100