microsoft / microsoft/TypeScript
Support parsing TSDoc string comments
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Hi there!
I had a issue trip around Github and finally ended up here :)
Last issue was: https://github.com/microsoft/vscode/issues/95408
I am using String Literal types to define classnames and would love to populate with some more information.
So basically:
type TClassnames =
/** Some docs about red-500 */
| 'bg-color-red-500'
/** Some docs about red-600 */
| 'bg-color-red-600'
I would expect it to populate the docs on the right side of the intellisense:
This is how we can document with properties:

Which would be amazing to have on string literals.
I thought it was a TSDoc issue, but given this context: https://github.com/microsoft/tsdoc/issues/164, it seems to be VSCode not parsing it... though then it seems to actually be Typescript related?
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
The issue does not name files or tests; start by tracing TypeScript's language-service completion details for string-literal union members and compare the existing property documentation behavior. Done means TSDoc comments attached to individual string literals appear in IntelliSense, with coverage for the demonstrated union pattern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100