Sie sind hier: Dokumentieren
Close
Doc-O-Matic 10
Dokumentieren

In Doc-O-Matic können Sie ganz einfach Ihren Sourcecode dokumentieren und Anwenderhandbücher verfassen. In Doc-O-Matic ist ein mit allen Funktionen ausgestatteter Texteditor und der Inhalts-Designer mit dem Sie die Themen und Symbole verschieben können enthalten. Zusätzlich gibt es einige Funktionen, die Ihnen helfen den Dokumentationsprozess zu beschleunigen und zu automatisieren wie zum Beispiel QuickDoc und AutoDoc.

Platzierung der Kommentare

Wenn Sie Doc-O-Matic verwenden, können Sie Ihre Kommentare entweder in den Sourcecode oder extern in einer DTX-Datei, einer HTML-Datei oder einer Textdatei speichern. Der Vorteil davon Kommentare in Ihren Sourcecode zu schreiben besteht darin, dass die Kommentare immer mit dem nächstgelegenen Symbol assoziiert werden, auch wenn sich der Name dieses Symbols ändert. Dokumentation im Sourcecode ist daher in dieser Beziehung immer aktuell. 

Wenn Sie einen Symbolnamen ändern müssen die Kommentare in der DTX-Datei angepasst werden. Ansonsten können die Kommentare nicht mehr mit dem entsprechenden Symbol assoziiert werden. Die Themen gehen allerdings nicht verloren, sie erscheinen nach den Symbolen in der Themenhierarchie. Die Option Assign to Symbol des Editors unterstützt Sie dabei für Kommentaren in DTX-Dateien das passenden Symbolen zu suchen. 

Der Vorteil davon, die Kommentare außerhalb des Sourcecodes zu schreiben ist, dass der Sourcecode nicht durch die Kommentare unübersichtlich wird. 

Dieser Teil enthält folgende Abschnitte:

Auf der Seite [General Settings]-> Documentation-> Topic Processing-> Multi Topics können Sie bestimmen, wie Sie Kommentare, die sich an verschiedenen Stellen befinden behandeln möchten. Mit Hilfe des Werkzeuges Move Documentation können Sie alle Kommentare aus dem Sourcecode in DTX-Dateien verschieben oder kopieren. Weiter Informationen finden Sie in Dokumentation verschieben.

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.