Einleitung: Warum ein Code-Review in TypeScript wichtig ist
Code-Review (Code-Überprüfung) ist der Prozess, bei dem geschriebener Code von anderen Entwicklern überprüft wird. Für angehende TypeScript-Entwickler ist dies nicht nur eine Formalität, sondern ein mächtiges Lernwerkzeug. Ein richtiges Review hilft, Fehler frühzeitig zu erkennen, die Architektur zu verbessern und einen einheitlichen Stil im Team beizubehalten.
In diesem Artikel gehen wir darauf ein, worauf Sie bei einem Code-Review in TypeScript konkret achten sollten, wie Sie Feedback geben, damit es nützlich ist, und zeigen Codebeispiele. Das Material richtet sich an Anfänger, die gerade erst mit TypeScript arbeiten und ihre Review-Fähigkeiten verbessern möchten.
1. Typisierung: Die Grundlage von TypeScript
Das Erste, was in TypeScript überprüft werden muss, ist die Korrektheit der Typen. TypeScript fügt statische Typisierung hinzu, was die Anzahl der Fehler reduziert – allerdings nur, wenn die Typen korrekt verwendet werden.
Was zu prüfen ist:
- Explizite Typen für Parameter und Rückgabewerte. Vermeiden Sie
anywo immer möglich. - Verwendung von Interfaces und Typen anstelle von Primitiven für komplexe Strukturen.
- Korrekte Verwendung von Union- und Intersection-Typen.
- Keine unnötigen Typzusicherungen (Type Assertions).
// Schlecht: impliziter Typ und anyfunction processData(data: any) { return data.name;}
// Gut: explizites Interfaceinterface User { name: string; age: number;}
function processData(data: User): string { return data.name;}Achten Sie beim Review auf Stellen, an denen der Typ any durch einen spezifischeren ersetzt werden könnte. Das erhöht sofort die Lesbarkeit und Sicherheit des Codes.
2. Prüfung auf null und undefined
TypeScript hilft, Fehler mit null und undefined durch strikte Null-Prüfungen zu vermeiden. Dennoch vergessen Entwickler oft, optionale Werte zu behandeln.
Was zu prüfen ist:
- Verwendung von
?für optionale Eigenschaften und Parameter. - Prüfung auf
nullvor dem Zugriff auf Eigenschaften. - Verwendung der Operatoren
??und?..
// Schlecht: kein Schutz vor undefinedfunction getLength(str: string | undefined): number { return str.length; // Fehler: str könnte undefined sein}
// Gut: Verwendung von optional chaining und nullish coalescingfunction getLength(str: string | undefined): number { return str?.length ?? 0;}Überprüfen Sie beim Code-Review, ob alle potenziell leeren Werte behandelt werden. Dies ist eine häufige Fehlerursache in der Produktion.
3. Sauberkeit und Lesbarkeit des Codes
TypeScript ist eine Erweiterung von JavaScript, daher bleiben die Prinzipien für sauberen Code relevant. Ein gutes Code-Review umfasst die Überprüfung von Stil und Struktur.
Was zu prüfen ist:
- Benennung von Variablen und Funktionen. Namen sollten aussagekräftig sein.
- Länge von Funktionen. Wenn eine Funktion mehr als eine Sache tut – teilen Sie sie auf.
- Kommentare. Sie sollten das „Warum“ erklären, nicht das „Was“.
- Keine magischen Zahlen. Lagern Sie Konstanten in separate Variablen aus.
// Schlecht: magische Zahlen und unklarer Namefunction calc(a: number) { return a * 1.2;}
// Gut: Konstante und verständlicher Nameconst TAX_RATE = 0.2;
function calculateTotalWithTax(amount: number): number { return amount * (1 + TAX_RATE);}Stellen Sie sich beim Review die Frage: „Kann ein neuer Entwickler diesen Code ohne Erklärung verstehen?“ Wenn nicht – bitten Sie um Verbesserung.
4. Wie man Feedback gibt: Sanft und konstruktiv
Ein Code-Review ist keine Prüfung, sondern ein Dialog. Für Anfänger ist es besonders wichtig, Feedback ohne persönliche Kritik zu erhalten. Hier sind einige Regeln, die helfen, nützliche Kommentare zu geben.