Erweitert – reStructuredText
 | 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.
Für eine attraktivere Darstellung der Dokumentation von Bibliotheksobjekten im Bibliotheksverwalter können Sie in den Projekteigenschaften der Bibliothek das Dokumentationsformat reStructuredText auswählen (SPS‑Projekteigenschaften > Kategorie Common).
reStructuredText ist eine einfach zu lesende Auszeichnungssprache, die einfache Konstrukte verwendet, um die Struktur eines Dokuments und spezielle Textelemente wie zum Beispiel Abschnittsüberschriften, Aufzählungslisten und Hervorhebungen zu kennzeichnen. Explizitere Konstrukte werden verwendet, um Grafiken und Hinweise einzubinden oder um Textelementen eine Funktion zuzuweisen (Hyperlinks).
Textelemente, die Sie im Kommentar oberhalb der Deklarationszeile eines Bibliotheksobjekts entsprechend der Syntax von reStructuredText auszeichnen, werden bei der Bibliothekserstellung im Bibliotheksverwalter in der Registerkarte Dokumentation strukturiert und formatiert dargestellt und optional mit einer Funktion versehen.
Der Kommentar oberhalb der Deklarationszeile folgender Objekte wird interpretiert:
- POU-Objekte (Programm, Funktionsbaustein, Funktion)
- Schnittstellen
- Methoden, Eigenschaften
- Globale Variablenlisten, Parameterlisten
- DUT-Objekte (Aufzählung, Struktur, Union, Alias)
Siehe auch: