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)
 | TE1030 | TwinCAT 3 Documentation Generation Für eine bessere Darstellung und einen größeren Funktionsumfang im Bereich der Dokumentation empfehlen wir die Verwendung des Dokumentationstools TE1030 | TwinCAT 3 Documentation Generation. |
| Eingeschränkte Unterstützung von reStructuredText ab TwinCAT 3.1 Build 4026 Alternativ zum „TE1030 | TwinCAT 3 Documentation Generation“ steht das Dokumentationsformat reStructuredText zur Verfügung. Beachten Sie die im Folgenden beschriebene eingeschränkte Unterstützung dieser Funktionalität ab Build 4026. |
Bis einschließlich Build 4024:
- Erstellung von Bibliotheken mit reStructuredText-Dokumentation als Quellcode (*.library) oder kompilierte Bibliothek (*.compiled-library)
- Anzeige der reStructuredText-Dokumentation von Quellcode (*.library) oder kompilierten Bibliotheken (*.compiled-library)
Build 4026 bis einschließlich Version 4026.15:
- Keine reStructuredText-Unterstützung
Build 4026 ab Version 4026.16:
- Anzeige der reStructuredText-Dokumentation von kompilierten Bibliotheken (*.compiled-library)
- Verwenden Sie zur Erstellung der *.compiled-library mit reStructuredText-Dokumentation eine Remote-Manager-Version mit Build 4024.
Siehe auch: