microsoft / microsoft/TypeScript
Support @param tag on function type
Aperta
Nessuno ha ancora preso questa issue.
Domain: JSDoc
Domain: LS: Quick Info
Domain: LS: Signature Help
In Discussion
Suggestion
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Examples
/**
* @param a A doc
* @param b B doc
*/
type F = (a: number, b: number) => number;
Hover over a or b -- I would expect to see parameter documentation.
It would also be nice to get it at a in const f: F = (a, b) => a + b;.
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
Non viene indicato alcun file, test o punto di ingresso. Riproduci i due esempi di hover dell’issue e ispeziona la gestione esistente della documentazione @param; il lavoro è completato quando la documentazione dei parametri appare passando il mouse sui parametri di un tipo funzione e sui parametri di un valore tipizzato con quel tipo funzione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100