Abschluss |
Zeichen, die das Ende eines Kommentarblocks oder eines Abschnittes markieren. Doc-O-Matic entfernt diese Zeichen in der Ausgabe automatisch. |
Abschnitt Body-Source |
In Doc-O-Matic ein automatisch erzeugter Abschnitt in dem die Implementierung von Dateien und Funktionen dargestellt werden. |
Abschnitt Links |
Ein automatisch erzeugter Abschnitt, der Hyperlinks zu den Unterseiten von Abschnittstypen Themennavigation, Zusätzliche Information, Body-Source und Listen für Siehe auch anzeigt. In Visual Studio Vorlagen heißt der Abschnitt Siehe auch. |
Abschnitte vom Typ Zusätzliche Information |
In Doc-O-Matic Abschnitte, die mehr als einmal pro Thema verwendet und individuell benannt werden können. |
Abschnittstrennzeichen |
Zeichen, die Abschnittstext von Abschnittsbeginnzeichen trennen. |
Alias-Themen |
In Doc-O-Matic ein Thema, das anstelle eines anderen Themas in der Ausgabe angezeigt wird. |
Allgemeine Sourcedateien |
Die Datei einer Programmiersprache, die Doc-O-Matic nicht versteht und als DTX-Datei interpretiert. Der Kommentarstil muss spezifiziert werden und Themenidentifizierungszeichen müssen manuell für jedes Symbol eingegeben werden. Zum Beispiel VB6, Ada und SQL Dateien. |
Allgemeines Thema |
Ein Thema, das nicht mit einem Symbol im Sourcecode assoziiert wird. |
Als Absätze formatieren |
In Doc-O-Matic die Möglichkeit Werte und ihre Beschreibung untereinander darzustellen. |
Analysierbare Programmiersprachen |
Eine Datei einer Programmiersprache, die Doc-O-Matic analysieren kann. Doc-O-Matic erkennt und sortiert die Symbole in diesen Dateien. Beispielsweise Delphi, C, C++, C#, VB.NET, Java, PHP und ASPX können analysiert werden. |
Analysieren |
Den Sourcecode in kleine Einheiten zerlegen, so dass die Symbole im Sourcecode sortiert werden können und die Kommentare extrahiert werden können. |
Ausblendbare Abschnitte |
In Doc-O-Matic Abschnitte, die aus- und eingeblendet werden können, indem der Benutzer + neben der Abschnittsüberschrift klickt. |
AutoDoc |
Eine Funkton in Doc-O-Matic, die automatisch Inhalt für die Dokumentation erstellen und bestimmte Dokumentationsschritte automatisieren. |
AutoDoc-Ordner |
Eine Funktion in Doc-O-Matic, die automatisch Themen für Symbol-Verzeichnisse anlegt. Die Themen der Verzeichnisse sind Symbolthemen. |
Automatisch erzeugte Abschnitte |
In Doc-O-Matic Abschnitte, die Doc-O-Matic in der Ausgabe verwendet um bestimmten Inhalt zu präsentieren wie zum Beispiel Klassenhierarchien, Sourcecode und Symbolüberblicke. |
Automatische Hyperlinks |
Ein Doc-O-Matic Feature, das automatisch Hyperlinks von Wörtern und Symbolnamen zu Themen, deren Themen-IDs mit dem Wort oder Symbolnamen übereinstimmt oder mit ihm assoziiert werden kann, erstellt. |
Automatischer Abschnitt |
Eine Funktion in Doc-O-Matic, die automatisch eine Zusammenfassung vom ersten Satz eines Themas erstellt. |
Automatischer Text |
Eine Funktion in Doc-O-Matic, die automatisch erzeugten Text für undokumentierte Symbole einfügt. |
Autor in PDF |
Der technische Autor eines PDF-Dokumentes, dessen Name in der PDF- Zusammenfassung (eine Eigenschaft des PDF-Dokumentes) aufscheint. |
Bedingte Defines |
Eine selektive Kompilierung abhängig davon, ob eine bestimmte Bedingung wahr oder falsch ist. |
Beginnzeichen |
Abschnittsbeginnzeichen. Zeichen, die in Doc-O-Matic anzeigen, dass ein neuer Abschnitt beginnt. |
Benutzerdefinierte Abschnitte |
In Doc-O-Matic Abschnitte, die der Benutzer in seinem Projekt anlegt. |
Code-Auslassung |
Eine Funktion in Doc-O-Matic, die es dem Benutzer ermöglicht bestimmte Teile im Sourcecode zu markieren um sie von der Analyse auszuschließen. |
Container (Abschnitt) |
Ein automatisch erzeugter Abschnitt, der eine Verknüpfung zur Datei, dem Namespace und dem Modul, in denen die Klasse enthalten ist anzeigt. Der Abschnitt kann auch in Themen für Klassenmembers angezeigt werden. |
DTX-Dateien |
Ein Dateityp den Doc-O-Matic dazu verwendet Kommentare und allgemeine Themen zu speichern. DTX-Dateien werden auch Topic Files (Themendateien) genannt. (.dtx) |
Dateierweiterung |
Eine Reihe von Buchstaben, die zum Dateinamen hinzugefügt werden und die dazu dienen die Datei als Mitglied einer bestimmten Kategorie zu identifizieren. |
Dokumentationszeichen |
Ein beliebiges Textelement im Sourcecode das analysiert werden kann. |
Dreifach Schrägstrich-Kommentare |
Kommentarzeichen, die in .NET Programmiersprachen verwendet werden und die mit drei Schrägstrichen "///" anfangen. |
Eigenschaften-Tags |
Zeichen die verwendet werden, um das Aussehen von Themen zu verändern, zum Beispiel der Titel-Tag. |
Einstellungen |
In Doc-O-Matic eine Ansicht, die Optionsseiten in einem hierarchischen Baum anzeigt. |
Erweiterte Überprüfung der Sichtbarkeit |
Eine Funktion in Doc-O-Matic, die in der Standardeinstellung die Sichtbarkeit aller Mitglieder auf published setzt, wenn Sie von bestimmten Basisklassen abgeleitet sind. |
Exportstatus |
In Doc-O-Matic bestimmt der Exportstatus, ob ein Thema in der erzeugten Hilfe wiedergegeben wird. Der Exportstatus eines Themas kann für jedes Thema einzeln oder für alle Symbole eines Typs eingestellt werden. |
Flags |
In Doc-O-Matic kurzer Text, der mit einem Thema verknüpft ist. |
Formatierungselemente |
In Doc-O-Matic Designelemente, die das Aussehen der Dokumentation steuern. |
Geerbte Beschreibungen |
Eine Funktionalität von Doc-O-Matic bei der automatisch Beschreibungen von geerbten Symbolen kopiert werden. |
Globale Ordner |
Verzeichnisse für globale Symbole in einer Sourcecodedatei. |
Grafikverzeichnis |
In Doc-O-Matic die Verzeichnisse, in denen Grafiken gespeichert sein müssen, damit Sie in der Ausgabe angezeigt werden können. |
H1-H6 -Tags |
Der Code der Überschriften in HTML identifiziert. Zum Beispiel <h1>Das ist eine Überschrift</h1>. |
Ignorierte Zeilen |
In Doc-O-Matic Zeilen in Kommentaren, die aus dem Thementext entfernt werden. |
Include-Anweisung |
Ein Befehl in einer Sourcecodedatei der bewirkt, dass eine andere Sourcecodedatei an dieser Stelle gelesen wird. |
Indikatorengrafiken |
Grafiken, die bestimmte Informationen über Symbole oder Eigenschaften in Überblicken anzeigen. |
Integration in Hilfesystemen |
Die Integration eines Hilfesystems in das Hilfesystem einer Entwicklungsumgebung. Für die Integration werden Indexeinträge in einem speziellen Format benötigt. |
Interpretierte Dateien |
Eine Datei, die Doc-O-Matic als DTX-Datei interpretiert, wenn Sie die Datei zum Projekt hinzufügen. Zum Beispiel allgemeine Sourcedateien sind interpretierte Dateien. HTML- und Textdateien sind interpretierte Dateien, wenn sie Sie nicht in DTX-Dateien umwandeln. |
Javadoc |
Ein Kommentarstil, der von Java-Compilern verarbeitet wird. |
Konfigurationen |
In Doc-O-Matic die Einstellungen für die Ausgabe eines Dokumentationsprojektes. |
Label |
Eine Funktion in Doc-O-Matic, die es erlaubt Textteile zu markieren, um Sie später für verschiedene Konfigurationen unterschiedlich zu formatieren, Grafiken einzufügen, Präfixe und Suffixe anzuhängen und in unterschiedlichen Konfigurationen anzuzeigen oder wegzulassen. |
Leere Themen |
Themen, die keinen Text enthalten, der in die Ausgabe exportiert wird. |
Legenden |
In Doc-O-Matic automatisch erzeugte Tabellen, in denen die Grafiken der Legende und eine kurze Beschreibung im Unterabschnitt Legend des Navigationsabschnittes angezeigt werden. |
Link für Code kopieren |
In Doc-O-Matic automatisch erzeugter Hyperlink, den der Benutzer anklicken kann, um den Sourcecode in die Zwischenablage zu kopieren. |
Member-Auflistung |
In Doc-O-Matic die Aufzählung der Mitglieder von Strukturen, Unions und Aufzählungen im Abschnitt Members. |
Memberordner |
Verzeichnisse für Members von Klassen wie Methoden und Aufzählungen. |
Memberüberblicke |
Ein automatisch erzeugtes Thema, das alle Members einer Klasse auflistet. |
Module |
Eine Funktion in Doc-O-Matic, die es Ihnen ermöglicht große Projekte in kleinere Teile zu unterteilen. |
Navigationsabschnitt |
In Doc-O-Matic automatisch erzeugte Abschnitte, die Überblicke über Symbole und Themen und Hyperlinks zum Beispiel zu den übergeordneten Themen enthalten. |
Ordner |
Gruppierungsebenen für Themen, die nur Einträge im Inhaltsverzeichnis erzeugen. |
Ordner für überladene Funktionen |
Ordner für überladene Funktionen. Die überladenen Funktionen werden in einer Tabelle im Abschnitt Überladungsliste angezeigt. |
Pre-Tag |
Der Code, der vorformatierten Text in HTML identifiziert. In Text, der von Pre-Tags umschlossen ist, werden keine Abstände entfernt, es wird nicht automatisch umgebrochen und er wird mit einer Festbreitenschrift gerendert. |
Projektdatenbank |
Eine Datei (.doxdb), die alle Themen-IDs eines Doc-O-Matic Projektes als Ziele von Verknüpfungen für HTML Hilfesysteme, PDF-Dokumente enthält. |
Projekttitel |
Ein Name für ein Projekt in Doc-O-Matic. |
QuickDoc |
Eine Funktion in Doc-O-Matic, die den Dokumentationsprozess automatisiert. |
Sichtbarkeit |
Schlüsselwörter, die die Sichtbarkeit bestimmen wie privat, public oder protected. |
Sichtbarkeitsordner |
Verzeichnisse für Klassenmembers, die nach Ihrer Sichtbarkeit wie public, protected und private sortiert sind. |
Spezielle Themen |
Themen, die eine spezielle Bedeutung für Doc-O-Matic haben. Ihre Themen-ID beginnt mit !!. |
Standardabschnitt |
Ein Abschnitt der in Doc-O-Matic für Text verwendet wird, der am Anfang eines Themas steht und der nicht mit Beginnzeichen anfängt. |
Standardeinstellung |
Die Einstellungen, die verwendet werden, wenn der Benutzer keine Änderungen vornimmt. |
Standardthemenseite |
Die Seite, die angezeigt wird, wenn das HTML-Hilfesystem geöffnet wird. |
Symbolreferenz |
In Doc-O-Matic das Überthema für alle Symbole in der Hierarchie. |
Symbolthemen |
In Doc-O-Matic der Kommentar für ein Symbol. |
Textdatei (*.txt) |
Eine ASCII Textdatei. |
Themen-ID |
Eine eindeutige Zeichenfolge, die ein Thema in Doc-O-Matic identifiziert. Für Symbolthemen wird der vollständige Name des Symbols als Themen-ID verwendet. |
Themenidentifizierungszeichen |
Ein Zeichen, das in Doc-O-Matic dazu verwendet wird Themen zu identifizieren und einem bestimmten Symbol zuzuweisen. |
Titellinks |
In Doc-O-Matic Hyperlinks, die unterhalb des Titels von Themenseiten und anderen Seiten angezeigt werden. |
Trennzeichen für Abschnitte Parameter und Rückgabewerte |
Ein Zeichen, das den Parameternamen oder den Rückgabewert von deren Beschreibung trennt. |
Unbeendete Themen |
In Doc-O-Matic Themen, die der Benutzer als unbeendet kennzeichnet. Unbeendete Themen können von der Ausgabe ausgeschlossen werden. |
Versionskontrolle |
Eine Funktion in Doc-O-Matic, die sicherstellt, dass nur Themen die mit der Versionsnummer des Projektes übereinstimmen, ausgegeben werden. |
Versionsnummer |
Die Versionsnummer Ihrer Dokumentation. Die Funktion für die Aktualitätsüberprüfung verwendet die Versionsnummer, um die Ausgabe von nicht aktuellen Themen zu verhindern. |
Verwendungsinformation für Namespaces |
Ein Kontext für Namen eines Objektes. C++, Java, C#, VB.NET und Delphi 8 und später unterstützen Namespaces. |
Vordefinierte Abschnitte |
In Doc-O-Matic Abschnitte, die in der Installation mitgeliefert werden. |
Wörterbuchdatei |
Eine Datei, die alle Abschnittsnamen und alle Wörter, die Doc-O-Matic automatisch in der Ausgabe einfügt, und deren Übersetzung, enthält. |
XMLDoc |
Ein Kommentarstil, der von C# und VB.NET-Compilern im .NET Plattform verarbeitet wird. |
Zierzeilen |
In Doc-O-Matic Zeilen, die verwendet werden um die Lesbarkeit des Sourcecodes zu verbessern. |
Zuweisung von Schriftarten |
Eine Funktion in Doc-O-Matic, die sicher stellt, dass Dokumente, in denen nicht-standard PDF-Schriftarten verwendet werden, auf allen Computern lesbar sind. |
Überblicke |
In Doc-O-Matic automatisch erzeugte Überblicke von Symbole und deren Beschreibung, die im Navigationsabschnitt angezeigt werden. |
Überladenen Funktionen |
Funktionen mit demselben Namen. Die Funktionen sind nur durch Ihre Parametertypen oder Rückgabewerte oder beides unterscheidbar. |