Qualitätssicherungsfunktionen

Aus Appmethod Topics
Wechseln zu: Navigation, Suche

Nach oben zu Quelltext-Audits und -Metriken

Mit Quelltext-Audits und -Metriken können unternehmensweite Programmierstandards und -konventionen eingehalten, echte Metriken erfasst und Ihre Arbeit verbessert werden.

Sie können:

  • Audits für Object Pascal- und C++-Projekte anwenden.
    Hinweis: Appmethod C++ unterstützt auf 64-Bit-iOS-Geräten keine Audits.
  • Metriken für Object Pascal-Projekte anwenden.

Wie bei anderen QS-Funktionen (Qualitätssicherung) müssen Sie bei der Arbeit mit Quelltext-Audits und -Metriken verstehen, was warum gemessen wird. Sowohl Audits als auch Metriken analysieren den Quelltext. Sie dienen aber unterschiedlichen Zwecken. Audits und Metriken werden als separate Vorgänge ausgeführt. Da die Ergebnisse beider Vorgänge unterschiedlicher Natur sind, stehen verschiedene Funktionen für die Interpretation und Organisation der Ergebnisse zur Verfügung.

Warnung: Audits und Metriken stehen nicht für Designprojekte zur Verfügung.

Das Video Audits DCC in Object Pascal 2010 von Mike Rozlog (EN) zeigt, wie mit Audits doppelter Code gefunden wird.

Audits

Quellcode-Audits können in Object Pascal- und C++-Projekten ausgeführt werden.

Beim Ausführen von Audits können Sie bestimmte Audits (Regeln) auswählen, mit denen der Quelltext übereinstimmen muss. Die auszuführenden Audits werden für Object Pascal-Projekte im Dialogfeld QS-Audits und für C++-Projekte im Dialogfeld C++-QS-Audits ausgewählt. In den Ergebnissen der Audit-Verarbeitung werden nur die Verstöße gegen diese Regeln angezeigt, so dass Sie die Probleme einzeln untersuchen und entscheiden können, ob der Quelltext entsprechend korrigiert werden muss. Es steht eine Vielzahl von Audits zur Auswahl. Die verfügbaren Audits reichen von Entwurfsproblemen bis hin zu Namenskonventionen und stellen Beschreibungen der Funktionsweise des Audits sowie Lösungen zur Behebung von Verstößen bereit. Siehe die Listen der verfügbaren Audits im Dialogfeld QS-Audits für Object Pascal-Projekte und im Dialogfeld C++-Audits für C++-Projekte.

Metriken

Quellcode-Metriken können nur in Object Pascal-Projekten ausgeführt werden.

Metrikanalysen bewerten die Komplexität des Objektmodells und quantifizieren Ihren Quelltext. Es liegt dann an Ihnen, das Ergebnis der Metriken zu überprüfen und zu entscheiden, ob es akzeptabel ist. Anhand der Ergebnisse der Metriken können Sie erkennen, welche Teile des Quelltextes geändert werden müssen. Sie können auch Berichte erstellen, um die Gesamtauswirkungen der Änderungen in einem Projekt zu vergleichen. Zu allen Metriken werden auch Tipps für ihre Verwendung und für die Auswertung der Ergebnisse zur Verfügung gestellt. Die IDE unterstützt eine breite Palette von Metriken. Siehe die Beschreibungen der verfügbaren Metriken im Dialogfeld QS-Metriken.

Metrikergebnisse können auch grafisch dargestellt werden. Es gibt zwei grafische Ansichten, in denen die Metrikergebnisse zusammengefasst werden können: Balken- und Kiviat-Diagramme. Beide Diagramme werden über das Kontextmenü der Tabelle Metrikergebnisse aufgerufen.

Balkendiagramme

Verwenden Sie Balkendiagramme für Spalten im Fenster Metriken.

Das Balkendiagramm zeigt die Werte einer bestimmten Metrik für alle Packages, Klassen und/oder Operationen.

Die Farbe des Balkens gibt an, wie sich die betreffende Metrik zum festgelegten Grenzwert verhält:

  • Ein grüner Balken steht für Werte, die sich im erlaubten Bereich bewegen.
  • Ein roter Balken steht für Werte, die den oberen Grenzwert überschreiten.
  • Ein blauer Balken steht für Werte, die den unteren Grenzwert unterschreiten.
  • Eine dünne senkrechte rote Linie markiert den oberen zulässigen, eine dünne blaue vertikale Linie den unteren zulässigen Grenzwert.

Kiviat-Diagramme

Verwenden Sie Kiviat-Diagramme für Zeilen im Fenster Metriken.

Das Kiviat-Diagramm zeigt das Ergebnis der Analyse für die aktuell ausgewählte Klasse oder das aktuell ausgewählte Package, berücksichtigt dabei aber nur Metriken mit vordefinierten zulässigen Grenzwerten. Die Ergebnisse der einzelnen Metriken werden auf Achsen abgebildet, deren Ursprung im Mittelpunkt des Graphen liegt.

Die Achsen sind logarithmisch, wobei die logarithmische Basis den oberen Grenzwert der Achse darstellt und daher alle oberen Grenzwerte dieselbe Entfernung vom Mittelpunkt haben. Die Werte und Grenzwerte werden dabei folgendermaßen angezeigt:

  • Ein roter Kreis stellt die oberen Grenzwerte dar. Alle Punkte außerhalb des Kreises verletzen den oberen Grenzwert.
  • Eine blaue Schattierung zeigt die unteren Grenzwerte an. Alle Punkte innerhalb der Schattierung verletzen den unteren Grenzwert. Bereiche mit einer Untergrenze von 1 oder 0 sind nicht schattiert.

Wenn Sie den Mauszeiger über das Diagramm führen, werden Informationen über die Metriken bzw. die Metrikwerte angezeigt, auf denen sich der Cursor befindet.

Kiviat-Diagramme verwenden die folgenden grafischen Elemente:

  • Alle Metriken bilden einen Stern. Die Werte der einzelnen Metriken sind als Punkte dargestellt.
  • Grüne Punkte stehen für akzeptable Werte.
  • Blaue Punkte stehen für Werte, die die unteren Grenzwerte unterschreiten.
  • Rote Punkte stehen für Werte, die die oberen Grenzwerte überschreiten.
  • Im rechten Winkel zu den einzelnen Strahlen des Kiviat-Graphen sind im Uhrzeigersinn Skalierungsmarken angeordnet.
  • Die blauen Marken gegen den Uhrzeigersinn stellen die Untergrenzen dar.

Aktive Audit- und Metrik-Sets

In den Dialogfeldern QS-Audits und QS-Metriken werden die verfügbaren Audit- bzw. Metrik-Sets angezeigt.

Wenn Sie ein Projekt öffnen, sind die Standard-Sets der Audits und Metriken aktiv. Aktive Audits und Metriken sind in den Dialogfeldern QS-Audits und QS-Metriken mit einem Häkchen gekennzeichnet. Wenn Sie das Dialogfeld QS-Audits oder QS-Metriken öffnen und auf Ausführen klicken, werden alle aktiven Audits oder Metriken ausgeführt.

Wenn Sie nicht jedes Mal sämtliche Audits oder Metriken im Standard-Set ausführen wollen, können Sie eigene Sets mit aktiven Audits und Metriken (nur für Object Pascal-Projekte) speichern (in einer Datei). Gespeicherte Sets können (aus Dateien) geladen und bei Bedarf ausgeführt werden. Verwenden Sie dazu die Schaltflächen Set speichern und Set laden in der Symbolleiste der Dialogfelder QS-Audits bzw. QS-Metriken.

Sie können die Standard-Sets jederzeit mit der Schaltfläche Standard-Set festlegen wiederherstellen.

Siehe auch