microsoft / microsoft/TypeScript
Suggestion: Generate doc comments in emitted JS
Offen
Dieses Issue hat noch niemand übernommen.
Needs Proposal
Suggestion
VS Code Tracked
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
Support some level of automatically generating doc comments for non-TypeScript JavaScript consumers.
Need more details on what exactly people would like to see generated.
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
Es werden keine Dateien, Tests oder Einstiegspunkte genannt, und im Issue muss noch festgelegt werden, welche generierten Kommentare gewünscht sind. Kläre zunächst, welche Dokumentationskommentare JavaScript-Konsumenten benötigen und wie die erwartete ausgegebene Ausgabe aussieht. Als abgeschlossen gilt die Aufgabe, wenn ein vereinbarter Umfang und Tests vorhanden sind, die die festgelegten generierten Kommentare abdecken.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100