microsoft / microsoft/TypeScript

Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class

Aperta
#32,492 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Domain: LS: Refactorings Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Add ability to convert JsDoc comments in following situation:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
function Class() {}

must be converted to

/**
 * Some class description
 */
class Class {
  /**
   * Some constructor description.
   */
  constructor() {}
}

Right now you get following result:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
class Class {
  constructor() {}
}

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

Non viene indicato alcun file, test o punto di ingresso. Inizia individuando la conversione da funzione a classe ES2015 e la gestione di JsDoc; il lavoro è completato quando @classdesc diventa il commento della classe, mentre la descrizione del costruttore diventa il commento del costruttore, come mostrato negli esempi.

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

Valutazione

Stack tecnologico
javascript, typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.