Bei einem Java-Code-Review oder Qualitätsprüfung (QS) ist es wichtig, systematisch vorzugehen, um sicherzustellen, dass der Code den Standards entspricht, gut lesbar ist, effizient arbeitet und keine schwerwiegenden Fehler enthält.
Hier ist eine Mindmap für strukturierte Vorgehensweise in Form einer Checkliste oder auch in Textform.
Vorbereitung:
Klären Sie den Zweck des Reviews. Geht es um die Einhaltung von Coding-Standards, die Sicherstellung der Funktionalität, die Verbesserung der Leistung oder etwas anderes?
Bestimmen Sie den Umfang des Reviews. Welche Dateien, Klassen oder Methoden werden überprüft?
Legen Sie eine angemessene Zeit für das Review fest.
Überprüfung der Anforderungen:
Stellen Sie sicher, dass der Code die funktionalen und nicht funktionalen Anforderungen erfüllt.
Überprüfen Sie die Spezifikationen und Anforderungsdokumente und vergleichen Sie sie mit dem implementierten Code.
Überprüfung der Architektur:
Prüfen Sie, ob der Code die vereinbarte Architektur und Designmuster einhält.
Identifizieren Sie mögliche Verbesserungen oder Abweichungen von der Architektur.
Lesbarkeit und Struktur:
Überprüfen Sie die Namensgebung von Klassen, Methoden, Variablen usw.
Stellen Sie sicher, dass der Code gut strukturiert ist und leicht verständlich ist.
Achten Sie auf Kommentare und Dokumentation, um sicherzustellen, dass sie klar und relevant sind.
Fehler und Ausnahmen:
Suchen Sie nach potenziellen Fehlern, wie z. B. fehlende Validierung von Eingaben, nicht behandelte Ausnahmen usw.
Überprüfen Sie, ob Fehlermeldungen und Ausnahmen angemessen behandelt werden.
Leistung:
Identifizieren Sie Bereiche im Code, die möglicherweise die Leistung beeinträchtigen könnten.
Überprüfen Sie, ob ineffiziente Algorithmen oder Datenstrukturen verwendet werden.
Tests:
Stellen Sie sicher, dass ausreichende Unit-Tests vorhanden sind, die den Code abdecken.
Überprüfen Sie die Testabdeckung und stellen Sie sicher, dass sie angemessen ist.
Sicherheit:
Prüfen Sie, ob der Code gegen bekannte Sicherheitslücken geschützt ist.
Achten Sie auf potenzielle Angriffspunkte wie Injection-Angriffe, Cross-Site-Scripting usw.
Dokumentation:
Überprüfen Sie die Code-Kommentare, um sicherzustellen, dass sie ausreichend sind und den Code gut dokumentieren.
Prüfen Sie, ob externe Schnittstellen oder APIs angemessen dokumentiert sind.
Feedback geben:
Dokumentieren Sie alle gefundenen Probleme, Verbesserungsvorschläge oder Lob.
Geben Sie klar verständliches und konstruktives Feedback.
Download code-review.pdf.