microsoft / microsoft/TypeScript
Handle JSDoc @param with hyphen
Offen
Dieses Issue hat noch niemand übernommen.
Domain: JSDoc
Experience Enhancement
Suggestion
VS Code Tracked
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
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": []
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der TypeScript-JSDoc-@param-Verarbeitung, die von der im Issue gezeigten Quickinfo-Hover-Antwort verwendet wird. Reproduziere das Beispiel, verfolge, wo der Dokumentationsstring gebildet wird, und überprüfe, dass die zurückgegebene Dokumentation den Trennstrich auslässt und die Beschreibung beibehält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100