Erweitert – reStructuredText
 | 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. |
| 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. |
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: