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
Auffinden von Kommentaren

Doc-O-Matic extrahiert die Dokumentation für Symbole im Sourcecode aus den Kommentaren, die der Entwickler in den Sourcecode geschrieben hat. Kommentare können vor oder nach dem Symbol, das dokumentiert wird, oder an irgend einem anderen Platz im Sourcecode platziert werden. In der Standardeinstellung assoziiert Doc-O-Matic Kommentare mit dem Symbol, das auf die Kommentare folgt. Die nächsten Abschnitte beschreiben, wo Kommentare im Sourcecode platziert werden können:

  • Platzieren der Kommentare vor dem Symbol: Erklärt wo genau Kommentare platziert werden müssen, wenn diese Einstellung gewählt wurde.
  • Platzieren der Kommentare nach dem Symbol: Erklärt wo Kommentare stehen müssen, wenn diese Option gewählt wurde.
  • Kommentare ignorieren und Dokumentationszeichen verwenden: Erklärt wie man Doc-O-Matic so einstellt, dass es bestimmte Kommentare als Dokumentationskommentare und bestimmte Kommentare als Kommentare, die nur für den Entwickler bestimmt sind, identifiziert.
  • Das Beispiel: Kommentarblock, erklärt, was ein Kommentarblock ist und welche Information aus der Sourcedatei als Kommentar extrahiert wird.
  • Das Beispiel: Entfernung von Kommentarblöcken, erklärt, wie weit weg ein Kommentarblock von einem Symbol platziert sein kann und noch immer mit diesem assoziiert wird.
  • Das Beispiel: Bestimmen eines Symbols, erklärt, wie man einstellen kann, dass ein bestimmter Kommentar für ein bestimmtes Symbol verwendet werden soll.

In der Standardeinstellung assoziiert Doc-O-Matic Kommentare am Anfang einer Datei (es darf kein einziger Abstand zwischen dem Beginn der Datei und dem ersten Kommentarzeichen sein) mit der Datei und nicht mit dem darauf folgenden Symbol. Diese Funktion kann auf der Seite [General Settings] > Documentation > Comment Finding > File Comments ausgeschalten werden.

Kommentare finden, Dokumentationszeichen

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