Doc-O-Matic fügt automatisch Topic IDs, unter Verwendung des Namens der Datei zu Ihrer Textdatei hinzu. Wenn Ihre Textdatei mehr als einen Kommentarblock enthält, müssen Sie für jeden Kommentarblock eine eigene Topic ID hinzufügen, indem Sie das Themenidentifizierungszeichen, das in der Standardeinstellung auf @@ eingestellt ist, und den vollständigen Namen des Symbols, mit dem der Kommentar assoziiert werden soll, vor dem Kommentarblock einfügen.
Die folgende Datei ist ein Beispiel dafür, wie ein typische Textdatei aussieht. Nehmen Sie an Sie haben eine Funktion Sort:
@@List::Sort
The Sort function sorts the list.
Um richtig erkannt zu werden, muss das Themenidentifizierungszeichen die erste Zeichenkette in der Zeile sein und es darf kein Leerzeichen zwischen dem Identifizierungszeichen und dem Zeilenbeginn sein. Der gesamte Text zwischen dem Identifizierungszeichen und der nächsten Zeile mit einem Identifizierungszeichen wird als Beschreibungstext für das Symbol verwendet. Anders als bei Kommentaren im Sourcecode, muss der Kommentar nicht von Kommentarzeichen umgeben sein.
Nachdem Sie nun Ihre Textdateien vorbereitet haben, assoziiert Doc-O-Matic den Kommentar mit dem entsprechenden Symbol. Der Kommentar wird entweder im Editor (bei umgewandelten Dateien) oder in der Themen-Vorschau angezeigt.