Sie sind hier: Weitere Informationen > Technische Referenz
Spezielle Aufgaben
Technische Referenz
> Themen-IDs von Symbolen
Close
Doc-O-Matic 10
Themen-IDs von Symbolen

In diesem Abschnitt wird erklärt, wie Doc-O-Matic Themen-IDs für Themen von Symbolen in analysierbaren Sourcedateien erzeugt. Jeder Kommentarblock, den Sie in Ihren Sourcecode schreiben, wird zu einem Thema gemacht. Jedes Thema hat eine eindeutige Themen-ID, die aus dem vollständigen Namen des Symbols besteht. Die Themen-ID des Themas, das aus diesem Kommentar generiert wird

// The Sort function sorts the list. bool MyList::Sort()

lautet MyList::Sort. In einem ganzen Dokumentationsprojekt, muss jedes Thema eindeutig über seine Themen-ID identifiziert werden können. (Funktionen werden speziell behandelt Siehe unten).

Funktionen und überladene Funktionen

Wenn es zwei Funktionen mit demselben Namen und unterschiedlichen Argumenten gibt, würde der vollständige Name die Funktion nicht eindeutig identifizieren. Daher werden Funktionen nicht nur über Ihren Namen sondern mit Hilfe einer Kombination aus Namen und Parameterliste identifiziert. Die ID für überladene Funktionen ist die ID für das Symbol erweitert durch eine Liste von Namen von Argumententypen jeweils durch "@" getrennt. Zum Beispiel für C/C++

//Max@int@int int Max(int x; int y); //Max@double@double double Max(double x; double y);
Namespaces

In der Standardeinstellung werden die Informationen in Namespaces verwendet, um die ID jedes Symbols, das im Namespace deklariert ist, zu erweitern. Zusätzlich können Sie Verwendungsinformationen für Namespaces verwenden, damit das automatische Erstellen von Hyperlinks auch für Symbole in anderen Namespaces funktioniert. Um Verwendungsinformationen für Namespaces auch für vererbe Beschreibungen zu verwenden müssen Sie diese Funktion extra einschalten. Dies kann die Erzeugungsgeschwindigkeit drastisch erhöhen.

Behandeln von Namespaces, Themenverarbeitungsoptionen

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