Aufgabe: Code prüfen
Diese Aufgabe beschreibt, wie der Code zur Überprüfung der Implementierung überprüft wird.
Beziehungen
RollenHauptrollen: Zusätzliche Rollen: Unterstützende Rollen:
EingabenVerbindlich: Optional:
  • Ohne
Extern:
  • Ohne
Ausgaben
Schritte
Allgemeine Empfehlungen
Zweck: Allgemeine Empfehlungen für jede Überprüfung.

Wenn Sie Software mit hoher Qualität erstellen, ist die Überprüfung der Implementierung eine Ergänzung zu anderen Qualitätsmechanismen, z. B. Kompilierung, Integration und Test. Bevor Sie die Implementierung überprüfen, müssen Sie sie kompilieren. Erfassen Sie möglichst viele Fehler mit Tools, z. B. mit Prüfprogrammen für Coderegeln. Ziehen Sie in Erwägung, Tools zu verwenden, die eine Visualisierung des Codes erlauben. Vor der Überprüfung der Implementierung können Sie weitere Fehler ermitteln und beheben, wenn Sie den Code mit Tools zur Laufzeitfehlererkennung ausführen.

Die Vorteile, die sich aus der Überprüfung der Implementierung ergeben, sind folgende:

  • Umsetzung und Förderung eines einheitlichen Codierungsstils im Projekt. Die Codeüberprüfung ist eine effektive Methode für die Projektteilnehmer, den Richtlinien für die Programmierung zu folgen. Dabei ist es wichtiger, die Ergebnisse aller Autoren und Implementierer zu prüfen, als alle Quellcodedateien.
  • Ermittlung von Fehlern, die von automatisierten Tests nicht gefunden werden. Bei Überprüfungen von Implementierungen können andere Fehler erfasst werden als beim Testen.
  • Austausch von Kenntnissen und Wissenstransfer von den erfahrenen Mitarbeitern an die weniger erfahrenen.

Die Implementierung kann mit verschiedenen Techniken überprüft werden. Sie können eines der folgenden verwenden:

  • Untersuchung. Eine formale Bewertungstechnik, bei der die Implementierung detailliert untersucht wird. Untersuchungen gelten als produktivste Überprüfungstechnik, erfordern jedoch Schulung und Vorbereitung, damit gute Ergebnisse erzielt werden können.
  • Walkthrough. Eine Bewertungstechnik, bei der der Autor eines oder mehrerer Arbeitsergebnisse einen oder mehrere Prüfer durch die Implementierung führt. Die Prüfer stellen Fragen und kommentieren Technik, Darstellung, mögliche Fehler, Abweichungen von Codierungsstandards usw.
  • Code lesen. Eine oder zwei Personen lesen den Code. Wenn die Prüfer mit dem Lesen fertig sind, können sie zu einer Besprechung zusammenkommen, ihre Kommentare vorbringen und Fragen stellen. Die Besprechung ist nicht obligatorisch, die Prüfer können ihre Kommentare und Fragen stattdessen auch in Schriftform an den Autor weitergeben. Das Lesen des Codes wird zur Überprüfung kleiner Änderungen und als Vitalitätsprüfung empfohlen.

Die fachlichen Anforderungen für diese Rolle ähneln denen der Rolle: Implementierer. Personen, die diese Rolle übernehmen, sind oft Fachleute für die Programmiersprache, die zur Überprüfung des Codes verwendet wird. In den meisten Projekten wird diese Rolle mit erfahrenen Programmierern aus dem Implementierungsteam besetzt.

Siehe auch Abschnitt Technik: Überprüfungen.

Prüfpunkte für die Implementierung einrichten
Zweck: Eine Prüfliste für die Überprüfung der Implementierung erstellen.  


Dieser Abschnitt enthält eine allgemeine Prüfliste für die Überprüfung der Implementierung als Beispiel. Die Richtlinien für die Programmierung sollten die Hauptquelle der Informationen für die Codequalität sein.

Allgemein

  • Folgt der Code den Richtlinien für die Programmierung?
  • Ist der Code selbsterklärend? Ist es möglich, den Code durch einfaches Lesen zu verstehen?
  • Wurden alle Fehler, die durch Tools für Coderegelprüfung und/oder Laufzeitfehlererkennung ermittelt wurden, bearbeitet?

Kommentare

  • Sind die Kommentare auf dem neuesten Stand?
  • Sind die Kommentare klar und richtig?
  • Sind die Kommentare bei Codeänderungen einfach zu ändern?
  • Konzentrieren sich die Kommentare auf die Ursache und nicht auf die Vorgehensweise?
  • Wurden alle Überraschungen, Ausnahmefälle und Fehlerumgehungen kommentiert?
  • Wurde der Zweck der einzelnen Operationen kommentiert?
  • Wurden andere relevante Fakten zu den einzelnen Operationen kommentiert?

Quellcode

  • Hat jede Operation einen Namen, der sie beschreibt?
  • Haben die Parameter beschreibende Namen?
  • Ist der normale Weg über die einzelnen Operationen klar von anderen, außergewöhnlichen Wegen zu unterscheiden?
  • Ist die Operation zu lang, und kann sie durch Extrahieren zugehöriger Anweisungen in private Operationen vereinfacht werden?
  • Ist die Operation zu lang, und kann sie durch Verringerung der Anzahl der Entscheidungspunkte vereinfacht werden? Ein Entscheidungspunkt ist eine Anweisung, in der der Code verschiedene Richtungen nehmen kann, z. B. eine if-, else-, and-, while- und case-Anweisung.
  • Wurde die Verschachtelung von Schleifen minimiert?
  • Wurden alle Variablen gut benannt?
  • Ist der Code klar programmiert, und vermeidet er vermeintlich "clevere" Lösungen?
Prüfunterlagen vorbereiten und Mängel dokumentieren
Zweck: Ergebnisse der Überprüfung dokumentieren.
Sicherstellen, dass die identifizierten Mängel dokumentiert sind.  


Es empfiehlt sich, nach jeder Prüfbesprechung die Ergebnisse in Form von Prüfunterlagen zu dokumentieren. Darüber hinaus müssen Mängel in Änderungsanfragen dokumentiert werden (außerdem müssen sie schließlich jemandem zugeordnet werden, der sie bearbeiten und realisieren soll).



Eigenschaften
Mehrere Vorkommen
Ereignisgesteuert
Fortlaufend
Optional
Geplant
Wiederholt anwendbar