microsoft / microsoft/TypeScript
refactoring for turning // comments to /**
Open
Nobody has claimed this yet.
Domain: LS: Refactorings
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
https://github.com/Microsoft/TypeScript/search?q=refactoring+comments&type=Issues
Suggestion
Turn a selected block of double-slash comments to a slash-star-star comments.
Use Cases
Turning conventional // into JSDoc
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 repository search linked in the issue for existing refactoring and comment-handling code. Define the selected-block behavior for converting conventional // comments into /** comments, then verify that the resulting comments are valid JSDoc and that selection boundaries are handled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100