microsoft / microsoft/TypeScript
Hover documentation for typescript uses jsdoc rules and not tsdoc
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
- VS Code Version: 1.99.3
17baf841131aa23349f217ca7c570c76ee87b957
x64
- OS Version: N/A (happens on all)
Steps to Reproduce:
1. Write some typescript code and use the syntax required by tsdoc
2. Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
3. Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support
Examples:
Thinking that the [mandatory hyphen](https://tsdoc.org/pages/tags/param/) after a parameter name is a markdown hint for a bullet point

Not recognizing the `@defaultValue` tag, and assuming `@default` and `@defaultvalue`

Not understanding [`@remarks`](https://tsdoc.org/pages/tags/remarks/), which is marked as [core](https://tsdoc.org/pages/spec/standardization_groups/), meaning you are expected to recognize it
Not providing hover for `@typeParam`

(The list goes on...)
Also, this last remark isn't a bug, but it would be really, _really_ great if you would support [`@inheritDoc`](https://tsdoc.org/pages/tags/inheritdoc/) for hover.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par reproduire les exemples TSDoc listés dans VS Code 1.99.3, en comparant le texte de l’infobulle et la mise en évidence avec les règles TSDoc liées. Suivez ensuite le chemin de documentation des infobulles de TypeScript qui gère les balises JSDoc, puis vérifiez que les balises principales telles que @param, @defaultValue, @remarks et @typeParam sont reconnues avec le format attendu.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- developer-experience
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100