microsoft / microsoft/TypeScript
support destructuring parameter @param tag in tsdoc
Aperta
Nessuno ha ancora preso questa issue.
Experience Enhancement
Suggestion
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
tsdoc rule:
https://github.com/microsoft/tsdoc/issues/186
vscode issue:
https://github.com/microsoft/vscode/issues/80368
example:
/**
*
* @param bar - the bar parameter
* @param a - the first parameter
* @param b - the second parameter
* @param c - the third parameter
* @returns the return value
*/
function foo(bar: string, {
a,
b,
c
}:{
a: string,
b: number,
c: string
}) {
return bar + a;
}
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 con l’esempio di destrutturazione e rivedi le issue collegate di TSDoc e VS Code per comprendere il comportamento previsto di @param. Individua la documentazione di TypeScript o la gestione del language-service per i parametri destrutturati, quindi aggiungi una copertura che dimostri che a, b e c ricevono la documentazione dei parametri prevista.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100