microsoft / microsoft/TypeScript

Support formatting JSDoc comments

Aperta
#11,500 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: JSDoc Help Wanted Suggestion VS Code Tracked
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Formatting:

/**
      *    @param  { Object }    bar 
                */
function foo(bar) { }

Should result in:

/**
 * @param {Object} bar 
 */
function foo(bar) { }

Reported originally in https://github.com/Microsoft/TypeScript/issues/11456

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 l'esempio TypeScript dell'issue e confrontando l'output attuale del formatter con la formattazione JSDoc prevista. Il lavoro è completato quando l'indentazione, gli spazi intorno al tipo e al nome di @param e il delimitatore di chiusura corrispondono all'output previsto, senza modificare la funzione.

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

Valutazione

Stack tecnologico
typescript
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.