Grundlagen

Mit speziellen Kommentaren ist der Entwickler, der mit TwinCAT 3 ein Programm schreibt, in der Lage, erklärenden Text direkt in das TwinCAT-Projekt zu schreiben. Durch die Verwendung von speziellen Markups in den Kommentaren kann der Text automatisch ausgewertet werden. Zusätzlich wird auch die Struktur der Software genutzt, um Vererbungsbeziehungen und Abhängigkeiten darzustellen. Ein Inhaltsverzeichnis für die Dokumentation wird automatisch erzeugt. Hierfür werden keine weiteren Markups benötigt.

TwinCAT Documentation Generation verarbeitet mit Hilfe von Markups Dokumentationskommentare in Ihrem Code und formatiert diese zu einer Dokumentation, deren Namen und Speicherort Sie im Fenster TE1030-Tc3DocGen angeben. Als Ausgabeformat können Sie unter anderem HTML auswählen. Außerdem generiert Documentation Generation automatisch partielle Klassendiagramme, um die Abhängigkeiten der Code-Elemente zu zeigen.

Die automatische Generierung einer Dokumentation basiert auf den folgenden Informationen innerhalb eines TwinCAT-Projekts:

Hierarchie der Elemente

In der Hierarchie der Elemente stehen die Markups Description, Summary und Example oben. Diese drei Markups sind die Voraussetzung für die Verwendung vieler anderer Markups.

Das folgende Beispiel zeigt, wie das Markup Code in das höhergestellte Markup Description eingebettet werden kann:

(*!<description>Jetzt folgt ein Codeblock.

<code> iCount:=iCount+1 </code>

</description>*)

In der generierten Dokumentation sieht das wie folgt aus:

Grundlagen 1:

Die Dokumentation wird bei der Ausgabe automatisch in einzelne Abschnitte eingeteilt, die diese Hierarchie ebenfalls widerspiegelt:

Ausgabeformate

TwinCAT 3 Documentation Generation gibt Ihnen die Möglichkeit Ihre Dokumentation in drei verschiedenen Ausgabeformaten zu erstellen:

Die Integration in TwinCAT ist entsprechend wie folgt aufgebaut:

Grundlagen 2: