Zurückschreiben von Kommentaren

Wenn Sie den Editor zum Schreiben der Kommentare verwenden, schreibt dieser die Dokumentation an die Stelle, die Sie ausgewählt haben zurück. Es gibt mehrere Möglichkeiten, wie Sie kontrollieren können, wie der Text in den Sourcecode (in C++, C#, Delphi, IDL, Java, JavaScript, VB.NET, MATLAB, ASPX and JSP) oder die DTX-Dateien zurückgeschrieben wird.

Wenn Sie Abschnitte verwenden, um Ihre Themen zu strukturieren, werden die Abschnittsbeginnzeichen in Ihren Sourcecode zurückgeschrieben. Ein Thema mit einem Abschnitt Zusammenfassung und einem Abschnitt Parameter würde so aussehen:

// Zusammenfassung
// Locates a sting in this string list.
//
// Parameter
// S   -    The string to be located
// Index -  The index of S is returned.

Um die Einstellungen für Kommentare zu ändern

Auf den unten aufgelisteten Seite können Sie bestimmen:

Um zu bestimmen	Öffnen Sie die Seite
Wo Kommentarblöcke platziert werden	Kommentare finden
Welche Kommentarzeichen verwendet werden	Kommentarzeichen
Wie lang ein Textblock sein soll	Editoroptionen
Wie breit die eingefügten Kommentare mindestens sein werden	Kommentaroptionen
Ob Sie nur /// als zulässiges Kommentarzeichen verwenden möchten	Kommentare finden
Wie weit die Kommentare eingerückt sind	Kommentaroptionen
Ob Themen-IDs in den Sourcecode geschrieben werden	Editoroptionen
Ob Dokumentationszeichen verwendet werden oder nicht	Dokumentationszeichen
Ob Kommentarzeichen auf einer eigenen Zeile beginnen und enden	Kommentaroptionen
Ob Sie nur XML kompatible Tags verwenden wollen	Dokumentationsstandard

Um Einstellungen für Abschnitte zu ändern

Damit Doc-O-Matic eine andere Abschnittsüberschrift einfügt: Geben Sie auf der Seite Abschnitte in Starters des jeweiligen Abschnittes die Abschnittsbeginnzeichen, die Sie in Ihrem Sourcecode am Beginn dieses Abschnittes eingefügt haben möchten, als erste Zeichenkette in die Liste ein.
Um Zierzeilen vor den Beginnzeichen einzufügen, aktivieren Sie auf der Seite [General Settings] > Editor > Comments das Kontrollkästchen Insert trimmed lines before section starters.
Um immer Abschnittstrennzeichen zu verwenden, aktivieren Sie auf der Seite [General Settings] > Editor > Comments das Kontrollkästchen Always use section delimiters.
Um Javadoc-Tags als Dokumentationsstandard zu verwenden, aktivieren Sie auf der Seite Dokumentationsstandard das Kontrollkästchen Javadoc tags. Nur möglich für Sourcecode in C++, C#, Delphi, IDL, Java, JavaScript, VB.NET, MATLAB, ASPX and JSP .
Um XMLDoc-Tags als Dokumentationsstandard zu verwenden, aktivieren Sie auf der Seite [General Settings] > Editor > Standard das Kontrollkästchen XMLDoc tags. Nur möglich für Sourcecode in C++, C#, Delphi, IDL, Java, JavaScript, VB.NET, MATLAB, ASPX and JSP.
Um nur Tags, die mit dem XML-Standard kompatibel sind, zu verwenden, aktivieren Sie auf der Seite [General Settings] > Editor > Standard das Kontrollkästchen XMLDoc compatible tags.

Um Kommentare zu formatieren

Doc-O-Matic verwendet die ersten Zeichen für die entsprechenden Optionen auf der Seite [General Settings] > Documentation > Special Characters, um
- Aufzählungszeichen
- Tabellenausrichtungen und Kopfzeilen
- und Überschriften zu formatieren.
Wenn Sie möchten, dass andere Zeichen verwendet werden, geben Sie die gewünschten Zeichen als erste Zeichen in der entsprechenden Zeile ein.
Wenn Sie möchten, dass Doc-O-Matic Rahmen um Ihre Kommentare erzeugt, wählen Sie auf der Seite [General Settings] > Editor > Comments Walls aus und geben Sie die Zeichen ein, die Doc-O-Matic verwenden soll.
Um alle Walls gleich breit zu zeichnen, wählen Sie die gewünschte Breite in Minimum width of comment auf der Seite [General Settings] > Editor > Comments aus.

Hinweise

Wenn Sie das Kontrollkästchen Always use section delimiters auf der Seite [General Settings] > Editor > Comments aktiviert haben, verwendet Doc-O-Matic das erste Trennzeichen, das in der Liste der Trennzeichen auf der Seite [General Settings] > Sections > Delimiters eingetragen ist als Abschnittstrennzeichen.

Verwandte Einstellungen

Kommentare finden, Kommentarzeichen, Editor, Kommentaroptionen, Dokumentationsstandard

Verfügbar in: Doc-O-Matic Professional