reactjs / reactjs/react-docgen

[Feature Request] Support document tags

Aperta
#551 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

Can react-docgen parse document tags as metadata instead of description? Like @since, @see, @deprecated

/**
 * My Component
 * @since 1.2.0
 */
export function MyComponent() {}

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

L’issue non indica alcun file né un percorso di test; inizia esaminando il parsing esistente dei commenti e l’output dei metadati di react-docgen. Usa l’esempio con @since, @see e @deprecated come caso di accettazione: questi tag devono essere rappresentati come metadati anziché essere inclusi nella descrizione.

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

Valutazione

Stack tecnologico
typescript
Ambito
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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.