Sie sind hier: Benutzeroberfläche > Menü Datei
Weitere Teile der Benutzeroberfläche
Doc-O-Matic Tools
Mitteilungen
> Projekt-Assistent
Projekt-Assistent
Close
Doc-O-Matic 10
Projekt-Assistent

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. 

 

Willkommen
  • Geben Sie in Title den Namen Ihres Projektes ein. Der Projekttitel wird an verschiedenen Stellen der Ausgabe wiedergegeben. Der Titel sollte kurz (nicht länger als 128 Zeichen) und prägnant sein.
  • Geben Sie in Filename eine DOX-Datei an, um Ihr Projekt zu speichern. Um die Projektpfade unabhängig vom Installationspfad zu machen, verwenden Sie Pfad-Makros.
  • Um ein eigenes Verzeichnis für Ihr Projekt zu erzeugen, aktivieren Sie dieses Kontrollkästchen.
  • Geben Sie in Create In das Verzeichnis an in das Sie Ihre Dokumentation ausgeben wollen.

 

Projektvorlagen

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. 

 

Projektdateien

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.

  • Klicken Sie auf die Schaltfläche Add, um die Dateien hinzuzufügen und Remove, um diese wieder zu entfernen. Weitere Informationen darüber, welche anderen Dateien Sie zu Ihrem Projekt hinzufügen können, finden Sie in Hinzufügen anderer Dateien.

 

Dokumentationsoptionen

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.

  • Comments: Diese Einstellung definiert, wo in Ihrem Sourcecode Kommentare in Beziehung zu den Elementen des Sourcecodes (zum Beispiel Funktionen, Klassen- oder Mitgliederdeklarationen) plaziert sind. Kommentare können entweder vor oder nach dem jeweiligen Symbol plaziert sein.
  • Tokens: Einige Dokumentationssysteme (wie zum Beispiel Javadoc) verwenden spezielle Dokumentationszeichen vor jedem Kommentar, um Dokumentationskommentare von anderen Kommentaren zu unterscheiden. Wenn Sie Dokumentationszeichen verwenden, tragen Sie diese in das Dialogfeld ein.
  • Wenn Sie Ihren Sourcecode noch nicht dokumentiert haben, klicken Sie auf die Schaltfläche Next.

 

Support für XMLDoc / Javadoc

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. 

 

Abschnitte

Ü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.

  • Wählen Sie die Abschnitte, die Sie in Ihren Kommentaren verwenden aus und stellen Sie sicher, dass im Dialogfeld Starters die Worte, dies Sie als Abschnittsbeginnzeichen verwenden, eingetragen sind.
  • Wenn Sie noch nicht eingetragen sind, tragen Sie diese in Starters ein.
  • Wenn Sie Ihre Kommentare nicht strukturieren, wählen Sie den Abschnitt aus, in dem Ihre Kommentare wiedergegeben werden sollen (zum Beispiel der Abschnitt Remarks oder Description) und klicken Sie auf die Schaltfläche Set Default. Weitere Informationen darüber, wie Sie neue Abschnitte definieren können finden Sie in Neue Abschnitte.
    Beachten Sie bitte: Doc-O-Matic erkennt in der Standardeinstellung Abschnittsbeginnzeichen nur, wenn Sie die ersten Zeichen in einer Kommentarzeile (abgesehen von Umrandungen und Dokumentationszeichen) sind. Abschnittsbeginnzeichen müssen entweder in einer eigenen Zeile stehen oder Sie müssen durch Trennzeichen vom Abschnittstext getrennt sein. Damit auch Leerzeichen als Trennzeichen akzeptiert werden, öffnen Sie die Seite Abschnittstrennzeichen und wählen Sie die beiden Optionen aus.

 

Editor

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.

Beachten Sie bitte: Nur das DTX-Format unterstützt alle Funktionen des Editors.
 

Übersetzungsoptionen

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.

  • Wählen Sie in der Liste Output Language, die Sprache aus, die Sie in der Ausgabe verwenden möchten.
  • Wenn Sie eine andere Sprache verwenden möchten, müssen Sie selbst eine Übersetzung auf der [General Settings] > General > Translation Seite erstellen.

 

Weiterführende Einstellungen
  • Die Vorlagedatei (vorlage.dtx) enthält Vorlagen, die Sie zur Erstellung von Themen verwenden können.
  • Doc-O-Matic unterstützt C/C++ Macro Erweiterungen und stellt eine Datei zur Verfügung, die weit verbreitete Macros von ATL, MFC, OWL und VCL Bibliotheken enthält. Wenn Sie einer dieser Bibliotheken verwenden, wird empfohlen diese Datei zu verwenden, da Doc-O-Matic damit die Struktur Ihres Sourcecodes besser versteht.

 

Linkdatenbanken

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.

Beachten Sie bitte: Zu den Hilfesystemen der Bibliotheken können nur von Hilfesystemen, die im gleichen Format sind, Hyperlinks erstellt werden.

Fertig stellen

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.

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