Code2Docu zur Generierung der Dokumentation

Mit Hilfe von "Code2Docu" wird aus Funktionen (FCs), Funktionsbausteinen (FBs) und PLC-Datentypen eines TIA Portal-Projekts eine Dokumentation generiert. 

"Code2Docu" unterstützt folgende Objekte:

• PLC Bausteine (FC, FB, Safety FC, Safety FB) in den Programmiersprachen SCL, AWL, FUP, KOP
• PLC Datentypen (UDT, Safety UDT / unterlagerte Strukturen)
• PLC Konstanten (Globale Konstanten)

Vorteile von "Code2Docu"

• Reduzierung der Engineering- und Abstimmungsaufwände
• Zeiteinsparung und dadurch Kostenreduktion
• Erhöhung der Engineering Effizienz
• Gleiches "Look and feel" für alle Objekte und alle Dokumentationen, da Template basierte Generierung
• Integration in CI/CD Workflows ("Continuous Integration" / "Continuous Delivery")
• Updatefähigkeit der Dokumentation:

       -Dokument Style

       -Änderungshistorie

• "Single point of source", Generierung der gesamten Dokumentation und der anwenderdefinierten Dokumentation (Anwenderhilfe) aus einer Quelle
• Alle dokumentierten Sprachen sind auch in den Objekten als Sprache hinterlegt (mehrsprachig)
• Die Dokumentation kann nicht "verloren” gehen, da sie zusammen mit dem Projekt gespeichert ist
• Entwickler können ihren Code direkt dokumentieren  --> Akzeptanzkriterium für Code Dokumentation

Hinweis:

Die in diesem Beitrag beschriebene Vorgehensweise bezieht sich auf den Zeitpunkt der Erstellung dieses Beitrags (Stand: Mai 2022).

Viele Grüße

Eure Fachberatung Deutschland (CG)