microsoft / microsoft/TypeScript
TypeScript: JSDoc tooltips are shared between types and values, but not functions
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
TS Template added by @mjbvz
TypeScript Version: 4.2.4
Search Terms
- quickinfo
- jsdoc
Issue Type: Bug
Steps to reproduce
- Create a TypeScript file.
- Create a type alias with some name, and write a JSDoc comment for it.
- For types and functions:
- Create a function with the same name, write a different JSDoc comment.
- Hover over the type name. You will see the function’s comment, followed by the type’s comment.
- Hover over the function. You will only see the function’s comment.
- For types and values:
- Create a value identifier with the same name, write a different JSDoc comment.
- Hover over the type name. You will see the type’s comment, followed by the value’s comment.
- Hover over the value identifier. You will see the type’s comment, followed by the value’s comment.
Reference file
/** A */
type X = null
/** B */
let X = null
/** C */
type Y = null
/** D */
function Y() {}
Screenshots




System and version info
VS Code version: Code - Insiders 1.56.0-insider (0123d26aaa393bccf99f31f1eac07df6c9e218ce, 2021-04-29T05:12:38.091Z)
OS version: Linux x64 5.11.0-7614-generic
System Info
| Item | Value |
|---|---|
| CPUs | Intel(R) Core(TM) i5-8300H CPU @ 2.30GHz (8 x 2300) |
| GPU Status | 2d_canvas: enabled gpu_compositing: enabled multiple_raster_threads: enabled_on oop_rasterization: disabled_off opengl: enabled_on rasterization: disabled_software skia_renderer: enabled_on video_decode: disabled_software vulkan: disabled_off webgl: enabled webgl2: enabled |
| Load (avg) | 2, 2, 2 |
| Memory (System) | 7.64GB (0.18GB free) |
| Process Argv | --no-sandbox --unity-launch --crash-reporter-id dbbd25fe-3f4e-426a-9c89-45e060834124 |
| Screen Reader | no |
| VM | 0% |
| DESKTOP_SESSION | pop |
| XDG_CURRENT_DESKTOP | Unity |
| XDG_SESSION_DESKTOP | pop |
| XDG_SESSION_TYPE | x11 |
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire le fichier TypeScript de référence et comparez les résultats de quickinfo pour la paire type/valeur avec ceux de la paire type/fonction. Suivez ensuite la gestion de quickinfo et de JSDoc impliquée dans ces hovers, puis ajoutez une couverture de régression pour les commentaires de tooltip attendus et vérifiez que chaque déclaration affiche la documentation appropriée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 50/100