Beim Schreiben von TypeScript-Code ist es wichtig, sich an bestimmte
Stilrichtlinien und Konventionen zu halten, um die Lesbarkeit und
Wartbarkeit des Codes zu gewährleisten.
Ein konsistenter und klarer Codierungsstil ist wesentlich für die
Lesbarkeit und Wartbarkeit von TypeScript-Projekten. Hier sind
erweiterte Richtlinien, die Ihnen helfen, hochwertigen Code zu
schreiben:
32.1 Benennung von Variablen,
Funktionen, Klassen und Interfaces
Verwenden Sie camelCase für Variablen und
Funktionen.
Nutzen Sie PascalCase für Klassennamen und Enums,
vermeiden Sie das I-Präfix für Interfaces.
Vermeiden Sie einbuchstabige Namen; wählen Sie stattdessen
beschreibende Namen.
Schreiben Sie Konstanten in UPPER_SNAKE_CASE und
verwenden Sie PascalCase für Enum-Namen und
UPPER_SNAKE_CASE für Enum-Mitglieder.
32.2 Typisierung
Verwenden Sie explizite Typen anstelle von any, wo
immer möglich.
Vermeiden Sie redundante Typzuweisungen; nutzen Sie die Typinferenz
von TypeScript.
Nutzen Sie Union-Typen, Literal-Typen und Type Aliases für mehr
Klarheit und Flexibilität.
Verwenden Sie readonly in Typen, um Unveränderlichkeit
anzudeuten.
32.3 Indentation und
Zeilenumbrüche
Wählen Sie Tabulatoren oder Leerzeichen zur Einrückung
(üblicherweise 2 oder 4 Leerzeichen) und bleiben Sie dabei
konsistent.
Begrenzen Sie Zeilenlängen auf 80-100 Zeichen und verwenden Sie
Zeilenumbrüche für längere Ausdrücke.
32.4 Semicolons
Der Einsatz von Semikolons ist optional. Wählen Sie einen Stil und
bleiben Sie konsequent dabei.
32.5 Importe und Exporte
Bevorzugen Sie ES6 Modulimporte (import) und -exporte
(export) gegenüber require() und
module.exports.
Organisieren Sie Importe logisch, zum Beispiel durch Trennung
externer Module von internen. Erwägen Sie die Verwendung von
Barrel-Dateien für sauberere Importpfade.
32.6 Funktionen und Klassen
Bevorzugen Sie Pfeilfunktionen für kürzere und sauberere
Funktionen.
Verwenden Sie Klassen und Interfaces, um Datenstrukturen zu
definieren, und achten Sie auf den angemessenen Einsatz von
Zugriffsmodifizierern (private, protected,
public).
Streben Sie nach reinen Funktionen, um Seiteneffekte zu minimieren
und Testbarkeit zu verbessern.
32.7 ESLint, Prettier und weitere
Praktiken
Verwenden Sie ESLint und Prettier, um Ihren Code automatisch zu
formatieren und stilistische Inkonsistenzen zu erkennen. Integrieren Sie
spezifische Regeln und Konfigurationen, die zu Ihrem Projekt
passen.
Nutzen Sie JSDoc für klare und konsistente Code-Dokumentation.
Befolgen Sie SOLID-Prinzipien für verbesserte Wartbarkeit und
Erweiterbarkeit.
Diese Richtlinien sind als Ausgangspunkt gedacht und sollten an die
spezifischen Anforderungen Ihres Projekts angepasst werden. Ein
konsistenter Codierungsstil fördert die Zusammenarbeit und verbessert
die Qualität des Gesamtprojekts.