microsoft / microsoft/TypeScript
Support formatting JSDoc comments
Offen
Dieses Issue hat noch niemand übernommen.
Domain: JSDoc
Help Wanted
Suggestion
VS Code Tracked
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Formatting:
/**
* @param { Object } bar
*/
function foo(bar) { }
Should result in:
/**
* @param {Object} bar
*/
function foo(bar) { }
Reported originally in https://github.com/Microsoft/TypeScript/issues/11456
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
Beginne damit, das TypeScript-Beispiel des Issues zu reproduzieren und die aktuelle formatter-Ausgabe mit der erwarteten JSDoc-Formatierung zu vergleichen. Erledigt ist dies, wenn Einrückung, Leerzeichen zwischen dem @param-Typ und dem Namen sowie das abschließende Begrenzungszeichen der erwarteten Ausgabe entsprechen, ohne die Funktion zu ändern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 35/100