microsoft / microsoft/TypeScript
Support formatting JSDoc comments
Open
Nobody has claimed this yet.
Domain: JSDoc
Help Wanted
Suggestion
VS Code Tracked
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Formatting:
/**
* @param { Object } bar
*/
function foo(bar) { }
Should result in:
/**
* @param {Object} bar
*/
function foo(bar) { }
Reported originally in https://github.com/Microsoft/TypeScript/issues/11456
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 issue's TypeScript example and comparing the current formatter output with the expected JSDoc formatting. Done means indentation, spacing around the @param type and name, and the closing delimiter match the expected output without changing the function.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100