microsoft / microsoft/TypeScript
JSDoc - generate @type for a variable
Open
Nobody has claimed this yet.
Awaiting More Feedback
Domain: JavaScript
Domain: JSDoc
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
From @egamma on February 22, 2017 11:21
Generating a JSDoc comment for a variable/constant should generate an @type annotation
/** |
var p;
Inserts
/**
* @type {any}
*/
var p;
Copied from original issue: Microsoft/vscode#21110
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 by reproducing the variable/constant JSDoc generation flow described in the issue using the provided JavaScript example. Done means the generated comment includes an @type {any} annotation before the variable declaration, matching the shown output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100