Text/Kommentare umschalten?

Wirkung

Der Modus "Switch text/comments" (Text/Kommentare umschalten) tauscht schlicht den sichtbaren Inhalt der Diagrammelemente aus: Wo üblicherweise der Anweisungstext dargestellt wird, werden jetzt die Kommentare der Elemente angezeigt, während der eigentliche Elementinhalt nur dann als Popup erscheint, wenn der Mauszeiger über dem jeweiligen Element verweilt – vorausgesetzt, der Modus "Show comments" ist ebenfalls aktiv.

Zweck

Der Algorithmusentwurf kann mit der Struktur und lediglich einer verbalen Beschreibung beginnen, was grob in einem Anweisungsblock, einer Schleife usw. geschehen soll. Diese grobe Skizze soll später durch formalere Ausdrücke verfeinert werden.

Wenn die Verfeinerung die beschreibenden Texte ersetzt (und damit löscht), gehen diese verloren. Dabei könnten sie als nützliche Kommentare dienen und ermöglichen, die Implementierung mit der ursprünglich spezifizierten Absicht zu vergleichen. Sie müssten in der Verfeinerungsphase aus dem Textfeld in das Kommentarfeld kopiert werden, was zwar möglich, aber umständlich ist. Warum also nicht von Anfang an Kommentare verwenden? Nun, weil das Diagramm bis zur Befüllung mit dem „eigentlichen Anweisungscode" leer und nichts sagend aussähe:

Genau hier greift der Modus "Switch text/comments". Er lässt sich im Menü "View" aktivieren und deaktivieren (vor Version 3.32-13: Menü "Diagram"):

(Beachten Sie, dass der Menüpunkt deaktiviert sein kann. Dies ist der Fall, solange der Modus "Comments plus text" aktiv ist, der Vorrang hat. Umgekehrt wird während des aktiven Modus "Switch text/comments" der Zugriff auf den Menüpunkt "Operators in C style" gesperrt, wie oben zu sehen.)

Im Modus "Switch text/comments" zeigen die Diagrammelemente ihre Kommentare anstelle des „Code"-Textes. So lässt sich ein Algorithmus allein auf Basis der informellen Kommentare entwerfen und dokumentieren:

Dieser Kommentar-Anzeigemodus dokumentiert den Entwurf auf abstrakter Ebene; alle Informationen bleiben (d. h. in den Kommentarbereichen) erhalten, auch nachdem der eigentliche Code in die Textbereiche eingetragen wurde. Sie sind damit jederzeit wieder abrufbar, wenn Sie erneut in diesen Modus wechseln.

Sie können die Elemente bearbeiten, wobei sowohl Text als auch Kommentare in den Editorformularen verfügbar sind, um die Code-Details einzutragen. Wenn Sie fertig sind (oder wann immer Sie möchten), können Sie in den Normalmodus zurückschalten, um die „Implementierung" zu sehen:

Sie können jederzeit zwischen beiden Modi wechseln, je nachdem, welchen Aspekt Sie in den Vordergrund stellen möchten.

Wechselwirkungen mit anderen Funktionen

Der Modus "Switch text/comments" verändert auf sinnvolle Weise, wie der Modus "Show comments" funktioniert: Wenn beide Modi kombiniert sind, zeigen die Kommentarmarkierungsbalken an, wo bereits eine Implementierung vorhanden ist. Entsprechend wird beim Verweilen des Mauszeigers über einem Element der Code (Text) als Popup angezeigt:

Seit Version 3.30-14 wird der Inhalt der Popups als formatierter Text dargestellt, wenn auch der Modus "Highlight variables?" aktiv ist (in diesem Fall kann der Anzeigemodus "Show operators in C style" zusätzliche Änderungen am Text bewirken):

Beim Öffnen eines Element-Editors (siehe Element bearbeiten) hängt es vom Modus "Switch text/comments" ab, ob der initiale Fokus (der Cursor) im Textbereich oder im Kommentarfeld liegt – es ist stets der Bereich, der im Diagramm dargestellt wird (mit seltenen Ausnahmen).

Der statische Analyser gibt in der Berichtsliste eine Warnung aus, solange der Modus "Switch text/comments" aktiv ist, damit unerfahrene Benutzer nicht in Panik geraten, wenn sie ihr Diagramm plötzlich leer sehen:

Seit Version 3.30-11 gibt es zusätzlich einen Modus-Indikator in der Symbolleiste (z. B. für den Fall, dass die Analyser-Berichtsliste deaktiviert ist) – siehe roter Kreis unten:

Beachten Sie, dass dieser Anzeigemodus unterdrückt wird, solange der Modus "Comments plus text" aktiv ist.