microsoft / microsoft/TypeScript
Handle JSDoc @param with hyphen
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
TypeScript Version: 2.7.0-dev.20171214
Code
/**
* @param x - Bla
*/
function foo(x) { }
Hover over x
Expected behavior:
Hyphen is ignored in any documentation returned. See JSDoc @param spec: http://usejsdoc.org/tags-param.html
Actual behavior:
Hyphen is returned as part of documentation:
[Trace - 2:58:07 PM] Response received: quickinfo (144). Request took 3 ms. Success: true
Result: {
"kind": "parameter",
"kindModifiers": "",
"start": {
"line": 4,
"offset": 14
},
"end": {
"line": 4,
"offset": 15
},
"displayString": "(parameter) x: any",
"documentation": "- Bla",
"tags": []
}
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 le traitement de TypeScript JSDoc @param utilisé par la réponse de quickinfo hover présentée dans l’issue. Reproduisez l’exemple, suivez l’endroit où la chaîne de documentation est formée et vérifiez que la documentation renvoyée omet le trait d’union séparateur tout en conservant la description.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- tooling
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100