QS-Ansicht

Die QS-Ansicht gibt einen Eindruck darüber, wie gut Ihre Sourcecode dokumentiert ist, welche Bereiche dokumentiert sind und welche nicht. Sie können den Filter verwenden um die Anzahl der angezeigten Themen und Symbole zu reduzieren.

Um die Darstellungsart zu ändern

Klicken Sie mit der rechten Maustaste in den QS-Raster.
Tun Sie folgendes:
- Wenn Sie möchten, dass ein Punkteraster angezeigt wird, wählen Sie Display Flat.
- Wenn Sie die Symbole hierarchisch anzeigen möchten, wählen Sie Display as Hierarchy.

Um Hinweise anzuzeigen

Klicken Sie mit der rechten Maustaste in den QS-Raster.
Wählen Sie Show Info aus.

Befehle und Schaltflächen der QS-Ansicht

Die folgende Tabelle erklärt alle Schaltflächen der Symbolleiste, alle Kommandos und Menüpunkte des kontextbezogenen Menüs:

Gruppe	Grafik	Befehl	Tastaturbefehle	Beschreibung
Display		Display as Hierarchy		Zeigt die Themen und Symbole hierarchisch als Treemap an, der Informationen über die Struktur der Symbole wie zum Beispiel Namespaces und in welchen Namespaces Symbole enthalten sind anzeigt.
Display		Display Flat		Zeigt die Symbole und Themen als Punkteraster an.
Display		Show Info		Blendet die Informationstexte ein oder aus.
Display		Filter		Blendet den Filter ein oder aus.
Display		Save as Bitmap		Speichert die QS-Matrix als Bitmap ab.
Display		Open Source	Eingabe	Öffnet den Sourcecode des ausgewählten Themas im eingetragenen Programm oder dem Programm, das in den Programmeinstellungen angegeben ist.
Document		QuickDoc	F4	Erzeugt ein neues Thema für das aktuelle Symbol entsprechend der QuickDoc-Einstellungen für dieses Symbol.
Document	>	QuickDoc Settings		Ändert die QuickDoc Einstellungen.
Document		Document	Strg+F4	Erzeugt ein neues Thema für das ausgewählte Symbol, wenn dieses noch undokumentiert ist.
Document		New Topic		Erzeugt ein neues Thema.
Document		New Snippet		Erzeugt ein neues Snippet.
Document		Copy Topic ID to Clipboard		Kopiert die Themen-ID des ausgewählten Themas in die Zwischenablage. Dies ist beim Bearbeiten der Topics sehr nützlich. Alle Themen-IDs sind auch in der Themen-Auswahldes Editors aufgelistet.
Document		Go to Content Manager		Wechselt zum Inhalts-Manager und hebt das ausgewählte Thema in der Hierarchie hervor.
		Select Colors		Öffnet die Programmeinstellungen der QS-Ansichts, in denen Sie die verwendeten Farben ändern können.

Farben und Teile der QS-Ansicht

Farbe	Bedeutung
Rot	Undokumentierte Symbole
Grün	Dokumentierte Symbole und Themen
Gelb	Symbole, die ihre Dokumentation von Vorgängersymbolen geerbt haben.
Blau	Symbole, denen die Dokumentation eines anderen Symbols zugewiesen ist, zum Beispiel durch die Benutzung des Funktion Kombinieren oder durch die Funktion überladene Funktionen.
Grau	Symbole, die als unbeendet gekennzeichnet sind.
Grüne Umrandungen für Module	Symbole, die zu einem Modul gehören.
Grüne/rote Umrandungenfür Namespaces	Symbole, die zu einem dokumentierten oder undokumentierten Namespace gehören.
Braune Umrandungen für Verzeichnisse	Symbole in Verzeichnissen.
Grüne/rote Umrandungenfür Klassen	Members, die zu dokumentierten oder undokumentierten Klassen gehören.

Für fortgeschrittene Benutzer

Auf der Seite QS-Optionen können Sie die Parameter für Ihre QA Kontrollen bestimmen. Mit Hilfe des Fehlercodes für QA Kontrollen des Kommandozeilencompiler und dem chk Kommando können Sie den Dokumentationsstatus Ihres Projektes überprüfen, ohne eine Ausgabe zu erzeugen.

Verfügbar in: Doc-O-Matic Professional