MIP40 Methoden der Softwaredokumentation

Das Programmverstehen ist die Grundlage der Fehlersuche, der Testplanung und der Testdurchführung. Das Programmverstehen beansprucht ca. die Hälfte der Zeit, um einen Testfall zu bearbeiten und abzuschließen.

Regressionstests sind dynamische Tests. Die Vorgabe von Sollwerten basiert auf vorangehenden Tests. Diese werden mit den Ergebnissen des Testlaufs verglichen. Bei kleinen Änderungen können die Tests inkrementell durchgeführt werden. Bei der Durchführung und für den Ergebnisvergleich kann eine Testautomatisierung genutzt werden. Falls erforderlich, muss durch Wrapping eine Testumgebung für die Tests der Module geschaffen werden.

Wrapper dienen der Isolierung von Komponenten beim Modultest. Die Module werden in einen Wrapper verpackt und damit gegenüber der Programmumgebung kontrolliert abgeschottet, sodass alle Auswirkungen und evtl. Nebenwirkungen kontrollierbar sind. Die Testtreiber übernehmen die Funktion der rufenden Komponenten. Die Stubs dienen als Platzhalter, sie simulieren die Funktionen und die Schnittstellen der Prozeduren.

Es gibt unterschiedliche Zählweisen bei der Bestimmung der LOC. Hierbei könnten auch Leerzeilen, Kommentarzeilen oder Deklarationen gezählt werden. Vorsorglich sollte man die Maße ELOC oder NOS benutzen. Ferner sollte bei dieser Größenangabe die Mächtigkeit und Kompaktheit des Codes der verwendeten Programmiersprache beachtet werden.

Für die Beurteilung der Wartbarkeit kann man den Wartungsindex bestimmen, der eine Klassifikation des Schwierigkeitsgrades erlaubt. Diese Metrik benutzt als Einflussgrößen die (durchschnittlichen Maße) der LOC, der Halstead-Metrik und der zyklomatischen Komplexität und berücksichtigt zusätzlich noch den Umfang der Kommentierung.

Die Unzuverlässigkeit kann als EUR-Betrag ausgedrückt werden. Sie gibt die durchschnittliche Höhe der Fehlerkosten pro Betriebstag an.

Die DIT-Metrik (Depth Inheritance Tree of Class) misst die Tiefe der Vererbung und liefert eine Aussage über Testbarkeit und Wartbarkeit, die umso schwieriger ist, je läääänger der maximale Weg in der Vererbungshierarchie ist.

Die Fan-In-/Fan-Out-Metrik dokumentiert die Anzahl der Aufrufbeziehungen einzelner Komponenten (Module, Prozeduren) als Eingang oder als Ausgang. Sie erfasst damit die Kohäsion und die Abhängigkeiten zwischen den Komponenten und ist ein Indikator für den Kopplungsgrad und die Modularisierung.

(vgl. Check-In/Check-Out)
Dateien müssen vor einer Änderung durch den Benutzer gesperrt und nach Abschluss der Änderung zurückgeschrieben und/oder wieder freigegeben werden. Während sie gesperrt sind, verhindert das System Änderungen durch andere Benutzer. Der Vorteil dieses Konzeptes liegt darin, dass kein Zusammenführen von Versionen erforderlich ist, da nur immer ein Entwickler die Datei exklusiv bearbeiten kann. Lange Wartezeiten bis zur Freigabe einer gesperrten Version sind für die anderen Benutzer allerdings von Nachteil.

Das System Git ist ein bekanntes verteiltes Open-Source-Versionsmanagementsystem, das beispielsweise auch für das Linux-Projekt eingesetzt wird.

Zu einer komfortablen Testumgebung gehören beispielsweise Testplanungs- und Testfalleditoren, eine Testfalldatenbank, ein Testdateneditor und Testtreiber, Werkzeuge für die Datenprüfung sowie dynamische und statische Analysatoren für die Codeanalyse.

Ein Bug-Tracking-System unterstützt die Kommunikation zwischen Benutzern, Tes- tern, Entwicklern und dem Management. Es hilft bei der Aufdeckung von Fehlern und Schwachstellen. Es verbessert die Transparenz der Wartungsprozesse und unterstützt damit das Konfigurationsmanagement.

Datengewinnung, Analyse und Visualisierung.

Statische Eigenschaften können erfasst werden, ohne das Programm auszuführen, dyna- mische Eigenschaften dagegen nicht.

Peter Flink wird den nicht von ihm selbst geschriebenen Code schneller verstehen und die relevanten Codestellen, an denen er Änderungen machen muss, schneller finden. Bei der Programmierung und beim Testen der Änderungen hilft ihm die Visualisierung, die Folgen dieser Änderungen zu sehen und die Ursache von eventuell beim Testen auftretenden Problemen schneller zu finden. Eventuell möchte er auch einen Kollegen oder Praktikanten einarbeiten in den Code, und hierbei hilft die Visualisierung ebenfalls, um wesentliche Eigenschaften des Programms zu erklären.

Die Qualität des Layouts ist entscheidend, weil
– die Effizienz des Benutzers beim Verstehen der visualisierten Inhalte davon abhängt,
– ein gutes Layout Anfängern hilft, zwischen wichtigen und unwichtigen Informationen zu unterscheiden,
– automatisches Layouten schwierig ist.

Ein Farbeindruck entsteht folgendermaßen: Auf der Netzhaut des Auges gibt es drei Arten von Rezeptoren, die jeweils auf Licht der drei Farben Magenta, Grün oder Orange ansprechen. Da Licht aus einer Mischung aus Licht verschiedener Wellenlängen bzw. Farben besteht, werden die Signale von den Rezeptoren vom Gehirn so kombiniert, dass ein Farbeindruck entsteht.

Eine Tree Map nutzt den Raum besser aus. Denn ein Baum verbraucht im Wurzelbereich so viel Platz für das einzelne Wurzelelement, wie auf der Blattebene für alle Blät- ter insgesamt zur Verfügung steht.

Zusätzliche Information gegenüber einer Informationspyramide: In der Information Landscape stellt die Höhe der Quader ein weiteres Attribut eines Elements dar.

Kopplung misst die Stärke der Wechselwirkung der Verbindung zwischen den Modulen, während Kohäsion den Grad der Abhängigkeit zwischen den Elementen innerhalb eines Moduls misst.

Eine hohe Kopplung einer Klasse mit den übrigen Klassen erkennt man im Aufruf- graphen daran, dass diese Klasse viele andere Klassen aufruft und/oder von vielen ande- ren Klassen aufgerufen wird.

Zum Kontrollfussgraphen für das Zeiterfassungs-Beispiel: a) Die zyklomatische Komplexität von McCabe ist definiert als die Anzahl der binären Verzweigungen des Kontrollflussgraphen plus 1.
b) Für dieses Beispiel beträgt die zyklomatische Komplexität nach McCabe 3 + 1 = 4. c) Nach McCabe soll die zyklomatische Komplexität maximal 10 betragen.

Ein hoher Grad an Kopplung zwischen Klassen bedeutet, dass der Code weniger leicht verständlich ist, außerdem Wiederverwendung, Änderungen und Fehlersuche erschwert.

Instrumentation code sind zusätzliche Anweisungen im Code, die für die Visualisierung gewünschte Daten ausgeben, z.B. in eine Protokolldatei.

Instrumentation code wird in Java üblicherweise eingefügt – vor und nach einem Methodenaufruf, um sie zu umschließen, – innerhalb einer Methode.

Bei nicht vorliegendem Java-Quellcode kann man dynamische Daten folgendermaßen ausgeben: – Methoden-Stubs, – Byte-Code-Injektion, – erweiterte Java Virtual Machine.