Clean Code
Zweck
Verbessern Sie Lesbarkeit, Wartbarkeit, Testbarkeit und Konsistenz des Codes, ohne unnötige Komplexität einzuführen.
Kernprinzipien
- Verwenden Sie aussagekräftige und konsistente Namen.
- Halten Sie Funktionen auf eine einzige Verantwortlichkeit fokussiert.
- Bevorzugen Sie einfache Lösungen gegenüber unnötigen Abstraktionen.
- Vermeiden Sie doppelte Geschäftslogik.
- Befolgen Sie SOLID-Prinzipien, wenn anwendbar.
- Bevorzugen Sie explizite Abhängigkeiten gegenüber versteckter Kopplung.
- Behandeln Sie Fehler klar und konsistent.
- Halten Sie Code leicht testbar und wartbar.
Arbeitsablauf
Beim Schreiben oder Refaktorieren von Code:
- Verstehen Sie das bestehende Verhalten und die Anforderungen.
- Identifizieren Sie konkrete Probleme der Codequalität.
- Schlagen Sie die kleinstmögliche sinnvolle Verbesserung vor.
- Bewahren Sie die bestehende Funktionalität, sofern keine Änderungen angefordert werden.
- Befolgen Sie die etablierte Architektur und Konventionen des Projekts.
- Fügen Sie relevante Tests hinzu oder aktualisieren Sie diese, wenn angebracht.
- Erklären Sie wichtige Änderungen und Zielkonflikte.
Refactoring-Richtlinien
- Refaktorieren Sie keine unabhängigen Module.
- Führen Sie keine Entwurfsmuster ohne klaren Nutzen ein.
- Vermeiden Sie verfrühte Optimierung.
- Bevorzugen Sie Komposition, wenn Vererbung unnötige Kopplung hinzufügt.
- Halten Sie öffentliche APIs kompatibel, es sei denn, breaking changes sind ausdrücklich genehmigt.
- Ändern Sie keine Geschäftsregeln stillschweigend.
- Vermeiden Sie das Hinzufügen von Abhängigkeiten ohne Begründung.
Validierung
Vor Abschluss einer Aufgabe:
- Überprüfen Sie, ob das angeforderte Verhalten implementiert ist.
- Prüfen Sie Benennung, Lesbarkeit und Doppelarbeit.
- Überprüfen Sie Fehlerbehandlung und Randfälle.
- Führen Sie relevante Tests und statische Analysen aus, wenn verfügbar.
- Melden Sie alle Tests, die nicht ausgeführt werden konnten.
Ausgabeerwartungen
Beim Vorschlagen von Verbesserungen:
- Erklären Sie das identifizierte Problem.
- Beschreiben Sie die vorgeschlagene Änderung.
- Setzen Sie die Änderung um, wenn autorisiert.
- Erklären Sie relevante Zielkonflikte.
- Fassen Sie die Validierungsergebnisse zusammen.
Projektanpassung
Befolgen Sie repositoriumspezifische Anweisungen und Technologiekonventionen.
Gehen Sie nicht davon aus, dass das Projekt eine bestimmte Sprache, ein bestimmtes Framework, eine bestimmte Datenbank oder eine bestimmte Architektur verwendet, es sei denn, dies wird durch den Repository-Kontext bestätigt.