Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Dokumentieren ohne Editor > In der Sourcedatei oder extern dokumentieren
Close
Doc-O-Matic 10
In der Sourcedatei oder extern dokumentieren

In Doc-O-Matic können Sie Ihren Sourcecode entweder in der Sourcecodedatei oder extern in einer DTX-Datei, in einer HTML-Datei, einer XML-Datei oder in einer Textdatei dokumentieren. Sie müssen zum Beispiel Ihre Typenbibliothek oder anderen automatisch erzeugen Sourcecode extern in einer anderen Datei dokumentieren. Für weitere Informationen darüber wie Sie HTML-Dateien, XML-Dateien und Textdateien verwenden, finden Sie in Andere Dateien hinzufügen

Der Vorteil davon, dass Sie den Sourcecode in der Sourcedatei dokumentieren ist, dass der Kommentar immer mit dem nächsten Symbol assoziiert wird, auch wenn sich der Name des Symbols ändert. Dokumentation, die im Sourcecode gespeichert ist, ist daher immer aktuell. 

Wenn Sie den Sourcecode in DTX-Dateien dokumentieren, müssen Sie die Kommentare anpassen, wenn sich der Name des Symbols ändert. Sonst kann Doc-O-Matic den Kommentar nicht mehr mit dem Symbol assoziieren. Die Kommentare gehen nicht verloren sondern werden am Ende der Hierarchie als allgemeine Themen gespeichert. Das Editorkommando Assign to Symbol hilft Ihnen dabei das entsprechende Symbol mit dem Kommentar in der DTX-Datei zu assoziieren. 

Der Vorteil davon außerhalb der Sourcedatei zu dokumentieren ist, dass die Sourcecodedatei nicht durch die Kommentare unübersichtlich wird.

Doc-O-Matic enthält das Werkzeug Dokumentation verschieben. Mit diesem Werkzeug können Sie die Kommentare von der Sourcecodedatei in eine DTX-Datei verschieben.

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