Bibliotheksdokumentation

Mithilfe von Kommentaren können Sie Bibliotheksobjekte und einzelne Elemente von Bibliotheksobjekten dokumentieren, um dem Anwender die Funktion und Verwendungsweise der über die Bibliothek bereitgestellten Programmelemente zu erläutern.

Die über die Kommentare erstellte Dokumentation wird im Bibliotheksverwalter, in dem die Bibliothek eingebunden ist, in den Registerkarten Ein/Ausgänge und Bibliotheksparameter (Beschreibung einzelner Elemente von Bibliotheksobjekten) sowie in der Registerkarte Dokumentation (Generelle Beschreibung von Bibliotheksobjekten) als Text oder als Tabelle angezeigt. (Siehe Grundlagen)

Bibliotheksdokumentation 1:

TE1030 | TwinCAT 3 Documentation Generation

Für eine attraktivere Darstellung und einen größeren Funktionsumfang im Bereich der Dokumentation empfehlen wir die Verwendung des Dokumentationstools TE1030 | TwinCAT 3 Documentation Generation.

Bibliotheksdokumentation 2:

Unterstützung von reStructuredText bis einschließlich TwinCAT 3.1 Build 4024

Bis einschließlich Build 4024 steht alternativ das Dokumentationsformat reStructuredText zur Verfügung.

Siehe auch: