microsoft / microsoft/TypeScript-Sublime-Plugin
Suggestion: Separate syntax coloring options for JavaDoc comments and regular comments
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 236
- Avg merge
- 21d 13h
- Merged PRs (30d)
- 1
Description
Visual Studio has this for XML doc comments and normal comments in C#.
Rationale: I (and others) tend to use JavaDoc/XmlDoc comments on top of methods as a way to create visual separation between methods, even if there is no comment. These get muddy when they're the same color as the nested comments.
Contributor guide
No contributing guide indexed for this repository
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 locating the repository's syntax-coloring configuration and how it distinguishes comment forms. The issue provides no file, test, or entry point, so first determine where JavaDoc/XML-style comments and regular comments are defined. Done means the two comment types have separate configurable colors, with coverage for the new distinction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100