reactjs / reactjs/react-docgen
Document TSDoc support
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
Related to #458, but TSDoc (a tool maintained by Miscrosoft) although influenced by JSDoc, has a strictly distinct syntax. For example, @default in JSDOC is @defaultValue in TSDOC. @inheritDoc doesn't have the same semantics, and require an argument in TSDoc... etc.
The full specification is yet to be written, but there is already a very well documented syntax reference here. See https://github.com/microsoft/tsdoc/issues/130 for updates on this specific issue.
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
Lies zunächst den verwandten Issue #458 und die verlinkte Referenz zur TSDoc-Syntax, und prüfe anschließend microsoft/tsdoc#130 auf Aktualisierungen der Spezifikation. Vergleiche die bestehende JSDoc-Verarbeitung mit der eigenständigen Syntax und Semantik von TSDoc; abgeschlossen ist die Aufgabe, wenn die vereinbarte TSDoc-Unterstützung dokumentiert und anhand der referenzierten Syntax validiert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100