microsoft / microsoft/TypeScript

Add properties in JSDoc generation on destructuring in javascript file

Aperta
#27,942 0 commenti 6 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: JSDoc Domain: LS: Quick Fixes In Discussion Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Search Terms

JSDoc destructuring generate property javascript

Suggestion

When you use the JSDoc generation on function using destructuring, it could list the properties.

Use Cases

Avoid redundancy when writing code.
It could be useful for Javascript files and Typescript files.

Examples

Action:
capture d ecran 2018-10-17 a 15 21 44

Actual:
capture d ecran 2018-10-17 a 15 22 00

Expectation:
capture d ecran 2018-10-17 a 15 22 48

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript / JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. new expression-level syntax)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo gli esempi di generazione JSDoc presenti nell’issue per le funzioni destrutturate in JavaScript e TypeScript. Segui il punto di ingresso della generazione JSDoc e i test esistenti, quindi verifica che la documentazione generata elenchi le proprietà destrutturate senza modificare l’output JavaScript a runtime.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.