microsoft / microsoft/TypeScript
Handle JSDoc @param with hyphen
Aperta
Nessuno ha ancora preso questa issue.
Domain: JSDoc
Experience Enhancement
Suggestion
VS Code Tracked
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
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": []
}
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla gestione di TypeScript JSDoc @param utilizzata dalla risposta di quickinfo hover mostrata nell’issue. Riproduci l’esempio, segui dove viene formata la stringa di documentazione e verifica che la documentazione restituita ometta il trattino separatore preservando la descrizione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- tooling
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100