Dev Report 04: NexaCode PLC Doku Generator
Mit dem vierten Dev Report geben wir ein weiteres Entwicklungsupdate zu NexaCode. Neben unserem Code Generator arbeiten wir nun auch an einem PLC Doku Generator. Während der Code Generator dabei hilft, standardisierte SPS-Strukturen effizient zu erzeugen, setzt der Doku Generator an einer anderen, aber genauso wichtigen Stelle im Engineering an: der Dokumentation. Gerade bei SPS-Bausteinbibliotheken ist Dokumentation oft ein Thema, das im Alltag viel Zeit kostet, schnell veraltet und bei Änderungen häufig manuell nachgepflegt werden muss.
Warum Dokumentation im SPS-Engineering so wichtig ist
Standardisierung im SPS-Engineering endet nicht beim Code. Ein sauber strukturierter Baustein ist nur dann wirklich nachhaltig nutzbar, wenn auch seine Schnittstellen, Funktionen und Änderungen verständlich dokumentiert sind. In der Praxis entstehen häufig leistungsfähige Bausteinbibliotheken, deren Dokumentation jedoch schwer aktuell zu halten ist. Sobald Bausteine erweitert, Parameter geändert oder Schnittstellen angepasst werden, muss auch die Dokumentation nachgezogen werden. Wenn dieser Schritt manuell erfolgt, entsteht zusätzlicher Pflegeaufwand. Gleichzeitig steigt das Risiko, dass Dokumentation und tatsächlicher Code auseinanderlaufen.
Was aktuell im NexaCode PLC Doku Generator entsteht
Der NexaCode PLC Doku Generator soll bestehende Bausteinbibliotheken auswerten und daraus automatisch eine nutzbare Dokumentation erzeugen. Der Fokus liegt darauf, technische Bausteinstrukturen verständlicher, aktueller und einfacher wartbar zu machen.
-
- automatische Dokumentation aus bestehenden Bausteinbibliotheken
-
- Unterstützung für Siemens, Rockwell und CODESYS
-
- Beschreibung von Eingängen, Ausgängen, Variablen und Parametern
-
- Dokumentation der grundsätzlichen Funktionsweise einzelner Bausteine
-
- Nutzung von Kommentaren aus Funktionen, Funktionsbausteinen und Variablen
-
- schnelles Neugenerieren bei Änderungen und bessere Pflege und Versionierung wachsender Bibliotheken
Dokumentation näher am Code halten
Ein wichtiger Ansatz ist die Dokumentation auf Basis vorhandener Kommentare innerhalb der Funktionen, Funktionsbausteine und Variablen. Aus diesen Informationen kann abgeleitet werden, welche Aufgabe ein Baustein erfüllt, welche Schnittstellen relevant sind und wie die Funktion im Engineering-Kontext verstanden werden kann. Dadurch bleibt die Dokumentation näher am eigentlichen Code. Gleichzeitig wird doppelte Pflege reduziert, weil Informationen nicht mehrfach an unterschiedlichen Stellen manuell gepflegt werden müssen.
Schnittstellen und Funktionsweise verständlich beschreiben
In den erzeugten Dokumenten sollen die Schnittstellen der Bausteine nachvollziehbar beschrieben werden. Dazu gehören Eingänge, Ausgänge, Variablen, Parameter und die grundsätzliche Funktionsweise. Gerade bei wachsenden Bausteinbibliotheken ist diese Transparenz wichtig. Anwender müssen schnell verstehen können, wofür ein Baustein gedacht ist, welche Informationen er benötigt und welche Signale oder Daten er bereitstellt. So wird aus einer technischen Bausteinstruktur eine verständliche und nutzbare Dokumentation.
Schneller aktualisieren bei Änderungen
Ein großer Vorteil entsteht besonders dann, wenn Bausteine weiterentwickelt oder angepasst werden. Statt bestehende Dokumente manuell zu überarbeiten, kann die Dokumentation aus der aktualisierten Bausteinbibliothek neu generiert werden. Das hilft, Dokumentation konsistenter und aktueller zu halten. Gleichzeitig wird der Pflegeaufwand reduziert, weil Änderungen im Code schneller in die Dokumentation überführt werden können. Gerade in Projekten mit vielen Bibliotheksbausteinen oder regelmäßigen Versionen ist das ein wichtiger Schritt.
Pflege und Versionierung von Bibliotheken verbessern
Mit wachsenden Bibliotheken wird es immer wichtiger, Änderungen nachvollziehbar zu halten. Neue Versionen, angepasste Schnittstellen und erweiterte Funktionen müssen nicht nur im Code, sondern auch in der Dokumentation verständlich bleiben. Der PLC Doku Generator unterstützt dabei, Dokumentation einfacher an neue Versionen anzupassen. Das verbessert Wartbarkeit und Nachvollziehbarkeit im SPS-Engineering. So kann Dokumentation starker Teil des Engineering-Prozesses werden und weniger als nachgelagerte manuelle Aufgabe verstanden werden.
NexaCode verbindet Codegenerierung und Dokumentation
Mit dem PLC Doku Generator entwickelt sich NexaCode Schritt für Schritt weiter. Es geht nicht nur um Codegenerierung, sondern um ein Werkzeug, das Standardisierung, Dokumentation und Wartbarkeit im SPS-Engineering zusammenbringt. Der Code Generator unterstützt beim Erzeugen standardisierter Strukturen. Der Doku Generator ergänzt diesen Ansatz, indem er die Dokumentation bestehender Bausteinbibliotheken vereinfacht und aktueller hält. Damit entsteht ein praxisnaher Werkzeugansatz für Engineering-Teams, die wiederkehrende Strukturen nicht nur effizient erstellen, sondern auch verständlich dokumentieren möchten.
Fazit: Dokumentation muss mit dem Engineering mitwachsen
Der NexaCode PLC Doku Generator setzt an einem wichtigen Punkt im SPS-Engineering an. Bausteinbibliotheken sind nur dann langfristig gut nutzbar, wenn ihre Schnittstellen, Funktionen und Änderungen verständlich dokumentiert bleiben. Automatisch generierte Dokumentation aus bestehenden Bibliotheken kann helfen, Pflegeaufwand zu reduzieren, Aktualisierungen zu beschleunigen und Versionierung nachvollziehbarer zu machen. Damit wird NexaCode Schritt für Schritt zu einem Werkzeug, das Codegenerierung, Dokumentation und Wartbarkeit im SPS-Engineering praxisnah zusammenbringt.