Um sicherzustellen, dass die Wiederverwendbarkeit von LabVIEW Code möglichst hoch ist, die Lesbarkeit des Codes möglichst gut ist, die Testbarkeit verbessert wird, die Wartbarkeit und Erweiterbarkeit möglichst simple ist, ist es unumgänglich, dass wir unseren LabVIEW Code ausreichend dokumentieren.

Dazu gibt es in LabVIEW verschiedenste Möglichkeiten, welche wir ausschöpfen sollten. Unser Hauptaugenmerk liegt heute auf dem VI Properties Editor von Merecs Engineering.

Hier ein Link zur Original Beschreibung.

Hier ein Link zum Package Download. (zur Installation wird er VI Package Manager von JKI benötigt)

Idealerweise würden wir ein LabVIEW VI direkt nach der Umsetzung dokumentieren. Da zu diesem Zeitpunkt die Aufgabe des VIs klar ist und somit die Beschreibung wenig Zeit in Anspruch nehmen würde. Dazu können wir die VI Description nutzen. Diese können wir mit STRG+I oder Rechtsklick auf das VI Icon -> VI Properties -> Drop Down (Documentation) editieren und abspeichern. Dieser beschreibende Text taucht anschließend in der Context Help auf (STRG+H).

Dies geschieht leider nicht immer unmittelbar. Dafür ist der VI Properties Editor eine ideale Möglichkeit um mehrere VIs hintereinander zu dokumentieren, ohne jedesmal separat das VI Properties Fenster öffnen zu müssen.

Nach Installation des VI Properties Editor´s (mit Hilfe des VI Package Managers) findet ihr in LabVIEW einen weiteren Menüeintrag.

LabVIEW -> Tools -> Merecs Engineering -> VI Properties Editor

Mit Open Folder könnt ihr nun euer gesamtes Projektverzeichnis oder zum Beispiel das Verzeichnis der Library öffnen. Klickt dazu im VI Properties Editor auf Open Folder, wählt anschließend den zu öffnenden Ordner aus und klickt dann auf Current Folder.

In der Liste auf der linken Seite sehen wir nun alle VIs. Bei Auswahl eines VIs sehen wir die dazugehörige VI Description. Nun können wir einfach und schnell alle VI Descriptions für unsere VIs ergänzen und anschließend mit Apply alle auf einmal speichern.

Im Workflow würde es sich zum Beispiel anbieten vor jedem Commit die VI Descriptions der neu erstellten VIs zu prüfen, ggf. zu ergänzen und abzuspeichern. Weitere Möglichkeiten zur Dokumentation eurer LabVIEW Projekte findet ihr in zukünftigen Posts.

Diese und viele weitere Tricks lernt ihr in unseren Schulungen und Consultings. Link zu den Terminen