Microsoft/TypeScript

Support formatting JSDoc comments

Offen

#11.500 geöffnet am 10.10.2016

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)TypeScript (13.395 Forks)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

Repository-Metriken

Stars
 (108.860 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Contributor Guide

Research-Richtung
Studieren Sie die Formatierungslogik für Kommentare im TypeScript Compiler, insbesondere wie JSDoc Kommentare derzeit verarbeitet werden, und modifizieren Sie den entsprechenden AST Besucher, um korrekte Einrückungen und Abstände anzuwenden.
Tech Stack
typescript
Domain
developer experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65