Sie sind hier: Dokumentieren > Themen > Erzeugen von Themen für Symbole
Erzeugen von Themen für Symbole
Close
Doc-O-Matic 10
Erzeugen von Themen für Symbole

Es gibt drei Möglichkeiten Kommentare mit dem Editor zu schreiben: Sie können:

  • Text zu bestehenden Kommentaren hinzufügen.
  • Einen neuen Kommentar für undokumentierte Symbole anlegen.
  • Einen Kommentar an einer anderen Stelle speichern.

Sie können die Kommentare zur Deklaration, zur Implementierung (nur wenn es sich um eine Methode oder Funktion handelt, von der Doc-O-Matic weiß, wo sie implementiert sind) oder in einer DTX-Datei speichern. DTX-Dateien sind eine spezielle Art von ASCII-Dateien, die Doc-O-Matic verwendet, um damit Kommentare außerhalb des Sourcecodes zu speichern.

  1. Wählen Sie im Contents Manager das Symbol aus, das Sie dokumentieren möchten.
  2. Klicken Sie auf der Registerkarte Managen, in der Gruppe Create Documentation auf Documentation .
  3. Klicken Sie Empty Topic , um den Kommentar wieder zu löschen.
  1. Klicken Sie auf Save .
  2. Wählen Sie im Dialogfeld Topic Location die Stelle aus, wo Sie den Kommentar speichern möchten (die Deklaration, die Implementierung (nur wenn es sich um eine Methode oder Funktion handelt, von der Doc-O-Matic weiß, wo sie implementiert sind) oder eine DTX-Datei).
  1. Klicken Sie im Dialogfeld Select Topic Location auf Select Other aus.
  2. Wählen Sie im Dialogfeld Select DTX das Verzeichnis aus, in dem Sie die DTX-Datei speichern möchten.
  3. Geben Sie einen Dateinamen ein.
  1. Wählen Sie das entsprechende Symbol aus.
  2. Klicken Sie mit der rechten Maustaste im Editor und klicken Sie dann auf New Topic Location.
  3. Speichern Sie den Kommentar entweder in einer DTX-Datei oder an einer anderen Stelle in der Sourcedatei (Implementierung oder Deklaration).
  1. Wählen Sie im Contents Manager das Symbol aus dessen Kommentar Sie bearbeiten möchten.
  2. Klicken Sie Save .
  3. Doc-O-Matic speichert den Kommentar an der Stelle, an dem es den bestehenden Kommentar extrahiert hat.

Bevor Sie eine Datei bearbeiten, klicken Sie auf der Symbolleiste für den Schnellzugriff auf Update All und lassen Sie alle Dateien von Doc-O-Matic analysieren. Doc-O-Matic kann keine Kommentare in eine Datei speichern, die geändert wurde (zum Beispiel im Source-Editor) und die danach nicht analysiert wurde.

Verfügbar in: Doc-O-Matic Professional

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