Sie sind hier: Weitere Informationen > Technische Referenz
Spezielle Aufgaben
Technische Referenz
> Programmier- und Dokumentationsstandards
Close
Doc-O-Matic 10
Programmier- und Dokumentationsstandards

Doc-O-Matic sollte es möglich sein den Sourcecode zu analysieren und die Kommentare zu extrahieren, ohne dass Anpassungen Ihres Dokumentationsstils notwendig sind. Es gibt jedoch einige Standards bei der Programmierung und beim Kommentieren, die Sie beachten sollten, damit Doc-O-Matic richtig arbeiten kann.

Programmieren

Jedes Symbol muss einen eindeutigen Namen haben. Wenn Sie zum Beispiel Enums und Funktionen verwenden, die den gleichen Namen haben, ist es notwendig eines der Symbole vor Doc-O-Matic mit Hilfe von Defines zu verstecken. In Wie kann ich verhindern, dass Symbole analysiert werden? finden Sie weitere Informationen hierzu. 

Symbolnamen müssen bei jeder Verwendung identisch sein. Ansonsten ist es nicht möglich, dass Doc-O-Matic Kommentare von verschiedenen Positionen zusammenfügt. Für Delphi/Pascal bedeutet das, dass Doc-O-Matic die Groß- und Kleinschreibung beachtet. Für C/C++ bedeutet das, dass Abstände in Symbolnamen immer an derselben Stelle eingefügt sein müssen. 

Um auch Funktionen zu verwenden, die im Projekt nicht deklariert sind, wählen Sie Funktionen ohne Prototyp verwenden, auf der Seite [General Settings] > Source Parsing > C++ Options aus.

Kommentare

Kommentare können entweder auf Symbole folgen, oder vor einem Symbol platziert sein. Es ist nicht möglich Teile des Kommentars vor und Teile des Kommentars nach dem Symbol zu platzieren. Dokumentationszeichen müssen das erste Zeichen in einer Kommentarzeile sein, damit Sie erkannt werden können. 

Walls, die Sie verwenden, um Ihre Kommentare hervorzuheben, werden von Doc-O-Matic entfernt, wenn Sie folgendermaßen aussehen: Die obere Begrenzung und die untere Begrenzung müssen aus einer Folge von gleichen Zeichen bestehen, die Seitenlinien können aus mehreren durchgehenden Zeilen von gleichen Zeichen bestehen. In Auffinden von Kommentaren und Entfernen von Walls finden Sie weitere Informationen zu diesem Thema.

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