Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Auffinden von Kommentaren
Datei und Analyseeinstellungen
Auffinden von Kommentaren
Close
Doc-O-Matic 10
Bestimmen eines Symbols

Manchmal ist es nützlich die Dokumentation für ein Symbol an einen anderen Platz in der Sourcedatei zu schreiben. Wenn die Dokumentation nicht vor oder nach der Deklaration eines Symbols steht, kann Doc-O-Matic die Dokumentation nicht automatisch mit dem Symbol assoziierten. Doc-O-Matic unterstützt eine Syntax, die es erlaubt, das Symbol zu bestimmen, zu dem der Kommentar gehört. Um die Zusammengehörigkeit zu definieren, benutzen Sie einfach das Dokumentationszeichen gefolgt (ohne Leerzeichen) vom vollständigen Namen des Symbols. Das folgende Beispiel zeigt den Kommentar für die Methode Sort in der Klasse List

(C++) //@@List::Sort // The Sort function sorts the list.

Beachten Sie bitte: Das Zeichen (Symbol Qualifier) ("::" oder ".") von der Programmiersprache abhängt, die Sie verwenden.

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