28. Oktober 2020
Der Kommentarknoten in QF-Test
Seit QF-Test 5.0.0 gibt es einen neuen Knoten, den Kommentarknoten:
Dieser Knoten kann überall eingefügt werden und hat (im Normalfall) keinen Einfluss auf die Testausführung sondern dient ausschließlich der Dokumentation:
Hervorhebungen
Um eine bessere Sichtbarkeit und Lesbarkeit von Kommentaren zu gewährleisten ist es möglich ein Kommentar (oder Teile eines Kommentars) durch Schriftauszeichnungen (d.h. fett, kursiv, ...) bzw. durch eine bestimmte Textfarbe hervorzuheben:
Um eine solche Hervorhebungen zu erreichen können die entsprechenden HTML-Tags verwendet werden. Hierbei beginnt man mit einem Anfangstag, welcher andeutet, dass ab hier eine bestimmte Schriftauszeichnung und / oder Farbe zu verwenden ist. Diese Schriftauszeichnung und / oder Farbe wird dann solange beibehalten, bis ein entsprechendes, sogenanntes End-Tag kommt.
Beispiel:
Normaler Text <b>fetter Text</b> wieder normaler Text
Hierbei deutet <b> an, dass ab hier der Text fett markiert werden soll (b steht für bold). Das anschließende </b> nimmt diese Schriftauszeichnung dann wieder zurück, sodass nur der mittlere Teil des Kommentars fett dargestellt wird.
Die Unterstützung für die folgenden Tags implementiert:
- <i> um zu markieren, dass ab hier der Text kursive dargestellt werden soll, </i> als End-Tag
- <u> um zu markieren, dass ab hier der Text unterstrichen werden soll, </u> als End-Tag
- <b> um zu markieren, dass ab hier der Text fett dargestellt werden soll, </b> als End-Tag
- <s> um zu markieren, dass ab hier der Text durchgestrichen werden soll, </s> als End-Tag
Für farbliche Markierungen kann man zu diesen Tags noch das color="Farbname" Attribut hinzufügen. Das heißt für einen fetten, blauen Text muss das Ganze wie folgt abgeändert werden:
<b color="blue">fetter, blauer Text</b>
Wobei man bei dem End-Tag nicht den Fehler machen darf, das color-Attribut zu wiederholen (also </b color="blue"> zu schreiben), auch wenn </b> sowohl die Schriftauszeichnung als auch die Farbe "zurücknimmt".
Um einen farblichen Text ohne Schriftauszeichnungen zu starten, kann <font> verwendet werden. Also:
<font color="green">grüner Text</font>
Hinweise
- Kommentare werden auch ins Protokoll geschrieben und sind auch für TestRunListener sichtbar.
- Auch wenn es nicht explizit verboten wurde - es macht nur bedingt Sinn einen Kommentarknoten einzufügen, welcher mit "->" beginnt. Mithilfe von "->" wird von QF-Test nämlich der gerade ausgeführte Knoten markiert. Dies kann dann zu Verwirrungen führen, weil ein solcher Kommentar den Eindruck erwecken kann, dass der Kommentarknoten gerade von QF-Test ausgeführt wird.