Der Projekt-Assistent hilft Ihnen dabei, ein neues Projekt für die Dokumentation Ihres Sourcecodes zu beginnen und dabei die grundlegendsten Einstellungen vorzunehmen. The Assistent besteht aus 12 einfachen Schritten.
Sie können aus verschiedenen Vorlagen, die Hilfe nach dem Vorbild weitverbreiteter IDEs erzeugen, auswählen. Um ein Projekt auf Grundlage der Standardeinstellung zu erzeugen, wählen Sie Default aus.
In diesem Schritt können Sie die Dateien, von denen Sie eine Dokumentation erstellen möchten, zu Ihrem Projekt hinzufügen. Sie können ganze Entwicklungsprojekte (Developer Studio (*.dsp), VS.NET, Delphi (*.dpk, *.dpr) und C++Builder (*.bpk, *.bpr)) oder einzelne Dateien (C++, C++.NET; VB.NET, C#, Java, ASP.NET, JavaScript, MATLAB, JSP und Delphi) und Textdateien (.txt), HTML-Dateien, XML-Dateien und DTX-Dateien hinzufügen.
Dokumentationsoptionen müssen richtig eingestellt sein, damit Doc-O-Matic die Kommentare in Ihrem Sourcecode richtig identifizieren kann. Wenn Sie nicht sicher sind, welche Einstellungen Sie vornehmen sollen, lassen Sie die Einstellung wie Sie in der Standardeinstellung sind.
Wenn Sie XMLDoc Kommentare oder Javadoc-Tags (@ oder \ verwenden, um Ihren Sourcecode zu dokumentieren, aktivieren Sie die Unterstützung für diese Dokumentationsstile. Jetzt versteht Doc-O-Matic die meisten Standard-Tags dieser Dokumentationstile.
Üblicherweise bestehen Kommentare aus einer Beschreibung, Bemerkungen, Siehe auch, Hyperlinks, Parameterbeschreibungen und einer Zusammenfassung. In Doc-O-Matic heißen diese Teile des Kommentars Abschnitte. In dieser Liste finden Sie alle vordefinierten Abschnitte, die Doc-O-Matic zur Verfügung stellt.
Auf dieser Seite können Sie bestimmen, wie Doc-O-Matics Editor Kommentare, die mit dem Editor geschrieben wurden, in die Sourcedateien einfügt. Wenn Sie die Kommentare außerhalb des Sourcecodes speichern möchten, finden diese Einstellungen keine Anwendung.
Doc-O-Matic fügt in die erzeugte Ausgabe automatisch verschiedene vordefinierte Wörter ein, um Ihre Dokumentation zu strukturieren (zum Beispiel Member, Methoden, Variablen). Doc-O-Matic verwendet dabei die Bezeichnungen für die Symbole, die in Ihrem Sourcecode verwendet werden. Wenn Sie Ihre Dokumentation in einer anderen Sprache als Englisch geschrieben haben, möchten Sie diese Worte möglicherweise durch Worte in Ihrer Sprache ersetzen.
Doc-O-Matic unterstützt Linkdatenbanken , die es Ihnen ermöglichen, einfach zu anderen Doc-O-Matic Projekten Hyperlinks zu erstellen. Darüberhinaus stellt Doc-O-Matic mehrere vorbereitete Linkdatenbanken zur Verfügung, die es Ihnen ermöglichen Hyperlinks in die Hilfesysteme bekannter Bibliotheken zu erstellen. Auf dieser Seite können Sie die vorbereiteten Linkdatenbanken zu Ihrem Projekt hinzufügen. Wenn diese Linkdatenbanken in Ihrem Projekt verfügbar sind, erstellt Doc-O-Matic jedesmal, wenn der Name eines Symbols der Bibliotheken in Ihrer Dokumentation verwenden automatisch Hyperlinks zu den entsprechenden Hilfethemen.
Das ist der letzte Schritt. Hier wird Ihnen ein Überblick über alle Einstellungen gegeben, die Sie vorgenommen haben. Wenn Sie auf die Schaltfläche Finish klicken, schließt Doc-O-Matic Ihr aktuelles Projekt (es wurde bereits gespeichert, wenn ungespeicherte Änderungen vorhanden waren) und erstellt ein neues Projekt mit den Einstellungen, die Sie ausgewählt haben. Danach werden die Sourcedateien analysiert. Dies kann zwischen einigen Sekunden und einigen Minuten dauern, abhängig davon, wie viele Dateien Sie zu Ihrem Projekt hinzugefügt haben und wieviele Dateien inkludiert wurden.