In den Themen dieses Abschnitts werden die Elemente der Benutzerschnittstelle für die Codeprüfung und die bereitgestellten Codeprüfungen beschrieben.
Voraussetzungen für die Ausführung von Codeprüfungen
Bei der Auswahl der Codebasis für die Ausführung einer Codeprüfung
ist darauf zu achten, dass der Code bestimmte Vorbedingungen erfüllt.
Vor allem muss für alle Dateien der Codebasis ein fehlerfreier Build- und
Kompiliervorgang durchgeführt worden sein, bevor Sie die Prüfung ausführen.
Beschreibungen der Regelkategorien
Regeln bilden die Grundlage einer Codeprüfung. Wenn Sie eine Codeprüfung ausführen, werden Regeln auf eine Codebasis angewendet, um festzustellen, ob der Code diesen Regeln entspricht.
Eine Regelkategorie ist eine Gruppe von Regeln für die Codeprüfung, die sich auf eine ähnliche Funktionalität oder auf einen bestimmten Qualitätsaspekt bezieht.
Codeprüfung - Arten
Die folgenden Codeprüfungen sind vordefiniert. Sie umfassen bestimmte Regeln und Regelkategorien, die sich auf Aspekte der Softwarequalität (z. B. Globalisierung) und auf
Softwareeigenschaften (z. B. Wertigkeit) beziehen.
Berichte
Unter Verwendung von Schablonen zum Exportieren von
Ergebnissen der Codeprüfungen an eine angegebene Position können Sie Berichte erstellen. Die Berichte
liegen im HTML- und XML-Format vor, und werden im Browser unmittelbar nach der
Erstellung angezeigt. Zeitgleich mit der Erstellung der Berichte
wird eine JSML-Version (JSML = JScrib Markup Language)
jedes Berichts erstellt.
Codeprüfung im automatischen Modus - Referenz
Mit dem automatischen Modus können Sie Codeprüfungen über
eine Befehlszeile oder ein Ant-Script ohne Benutzereingabe und ohne
Produkt-GUI automatisieren.
Sicht "Codeprüfung"
In der Sicht Codeprüfung wählen Sie den zu prüfenden Code aus und untersuchen die Ergebnisse der Codeprüfung. In dieser Sicht können Sie filtern, sortieren und suchen.
Sicht "Codeprüfung - Details"
Die Sicht Codeprüfung - Details enthält Informationen zu Ressourcen und zur Fehlerbehebung in Bezug auf das ausgewählte Ergebnis.
Sicht "Fortschritt"
Die Sicht "Fortschritt" enthält Statusinformationen für Hintergrund- und Verarbeitungsaufgaben im Zusammenhang mit Regeln für die Komplettprüfung im Rahmen der J2EE Best Practices-Codeprüfung. Regeln für die Komplettprüfung erzeugen nicht nur Ergebnisse, sondern zeigen auch die Pfade zu den Ergebnissen an. Diese Regeln erfordern eine Datenflussanalyse. Bei der Datenflussanalyse wird ein Trace für die Pfade durchgeführt, die zu einem Ergebnis führen. Diese Prüfung kann daher länger dauern als andere Codeprüfungen.
In der Sicht "Fortschritt" werden die gerade ausgeführte Aufgabe sowie der Verarbeitungsfortschritt angezeigt.
Seite "Java-Einstellungen - Codeprüfung"
Wählen Sie auf der Seite "Java-Einstellungen - Codeprüfung" im Fenster "Benutzervorgaben" die Codeprüfung aus, die Sie ausführen möchten. Auf dieser Seite definieren Sie auch den Regelsatz, indem Sie die Regeln inaktivieren, die bei der Prüfung nicht angewendet werden sollen, und die Regeleigenschaften ändern.
Fenster "Filter"
Im Fenster Filter können Sie den Status oder die Wertigkeit von Ergebnissen löschen, damit Ergebnisse mit den betreffenden Merkmalen nicht angezeigt werden.
Assistent Neue Regel für Codeprüfung
Der Assistent Neue Regel für Codeprüfung umfasst Schablonen für die Erzeugung anwendungsspezifischer Regeln, die Sie anschließend in die Codeprüfung integrieren können.
Fenster "Codeprüfungskonfiguration exportieren"
Im Fenster Codeprüfungskonfiguration exportieren können Sie eine angepasste Regelkonfiguration in eine komprimierte Datei exportieren. Andere Teammitglieder können die Konfiguration importieren, so dass das gesamte Team konsistente Codeprüfungen ausführen kann, bei denen genau dieselben Regeln und Einstellungen angewendet werden.