reactjs / reactjs/react-docgen
[Feature Request] Support document tags
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
Can react-docgen parse document tags as metadata instead of description? Like @since, @see, @deprecated
/**
* My Component
* @since 1.2.0
*/
export function MyComponent() {}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das Issue nennt weder eine Datei noch einen Testpfad; beginne damit, das vorhandene Parsen von Kommentaren und die Metadatenausgabe von react-docgen zu überprüfen. Verwende das Beispiel mit @since, @see und @deprecated als Abnahmekriterium: Diese Tags sollten als Metadaten dargestellt werden, anstatt in der Beschreibung enthalten zu sein.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100