+- LabVIEWForum.de (https://www.labviewforum.de)
+-- Forum: LabVIEW (/Forum-LabVIEW)
+--- Forum: LabVIEW Allgemein (/Forum-LabVIEW-Allgemein)
+--- Thema: LabView Dokumentation erzeugen (/Thread-LabView-Dokumentation-erzeugen)
LabView Dokumentation erzeugen - machfax - 17.03.2015 09:13
Hallo zusammen
Gibt es eine Möglichkeit, das LabView irgendwie automatisch zu dokumentieren wie ein pdf Export von allen VIs mit den entsperchenden States oder so? Gibt es eine Solche Funktuion und wenn ja wo?
Oder gibt es sonst eine Möglichkeit zur Dokumentation?
Danke & Gruss
RE: LabView Dokumentation erzeugen - GerdW - 17.03.2015 09:26
Hallo machfax,
Datei-Menü -> Drucken…
RTFM…
RE: LabView Dokumentation erzeugen - aljasik - 25.11.2016 12:57
Hallo.
In einer durch "Datei-Menü -> Drucken" erstellter Datei werden die Kommentare, die direkt im VI reingeschrieben wurden, nicht angezeigt. Gibt es auch andere Lösungen für Dokumentation? Durch die Verwendung z.B. von externen Tools.
Ich arbeite zurzeit an der Entwicklung einer semantischen Suchfunktion über Quellcodedateien. Für eine bessere Trefferquote will ich alles Auswerten, auch die Kommentare. Im Quellcode in textbasierten Sprachen ist es leicht.
Auch wenn ich eine LabView-Datei in einem Editor aufmache, kann ich nur die in VI-Dokumentation hinzugefügter Text sehen.
RE: LabView Dokumentation erzeugen - GerdW - 25.11.2016 13:09
Hallo aljasik,
Zitat:In einer durch "Datei-Menü -> Drucken" erstellter Datei werden die Kommentare, die direkt im VI reingeschrieben wurden, nicht angezeigtIch habe gerade mal ein eigenes VI drucken lassen: alle Kommentare, die ich im Blockdiagramm hatte, waren auch im PDF zu lesen!
Wieso werden die bei dir "nicht angezeigt"?
Zitat:Auch wenn ich eine LabView-Datei in einem Editor aufmache, kann ich nur die in VI-Dokumentation hinzugefügter Text sehen.Der "Quellcode" liegt in komprimierter Form vor - und damit auch die Kommentare, die im BD verteilt wurden…
Dein Problem ließe sich durch folgende Maßnahmen lösen/entschärfen:
- möglichst viel (aussagekräftige) Doku in der VI-Beschreibung hinterlegen
- mittels VI-Skripting die Kommentare im BD eines VIs auslesen und in Textdateien speichern…
RE: LabView Dokumentation erzeugen - aljasik - 25.11.2016 19:35
Danke für deine schnelle Antwort. Ich werde es noch mal mit Datei-Menü -> Drucken probieren.
VI-Scripting kenne ich nicht. Werde gleich nachschlagen.
Optimal wäre es natürlich ohne Erstellung einer Datei auszugehen. So, dass Entwickler die Quellcodedateien in eine zentrale Repository auf dem Server hochladen konnte (z.B. SVN). Und die Extraktion der Dokumentation dort automatisch passiert. Gibt es hierfür irgendwas? Dass ich z.B. den Text auch aus der komprimierten Form erkennen konnte?
RE: LabView Dokumentation erzeugen - th13 - 29.11.2016 13:18
VIs grafisch zu dokumentieren halte ich nicht für zielführend. Das nimmt zu viel Platz weg und hat keinen Mehrwert - da kann ich auch in den Code schauen.
Du kannst aber, wie Gerd schon schrieb, alle VIs des aktuellen Projektes durchgehen und alle möglichen Informationen auslesen. Zum Beispiel kann man in jedem VI einen Kommentar mit allen Ein/Ausgängen anlegen, dazu Version, Datum, Autor etc. Wenn das in einer bestimmten Syntax erfolgt, kannst du das parsen und daraus eine schöne Doku erstellen.
Informationen zum Dateiformat eines VIs kannst du evtl bei NI bekommen, aber ich bezwefle das dir das weiterhilft.
Auf dem VIP 2016 in Fürstenfeldbruck gab es zwei Veranstaltungen die dich interessieren dürften.
- Use #Bookmarks – Get Your Review Docs for Free!
Aus Kommentaren im Code werden Review-Dokumente erstellt.
- A Complete Toolchain of Continuous Integration for LabVIEW
Vorstellung von Tools für eine LabVIEW-Toolchain, inkl. automatischer Codechecks beim Einchecken ins Repository.
Vielleicht hilft dir das weiter. Downloads der Präsentationen findest du hier.
Thomas
RE: LabView Dokumentation erzeugen - aljasik - 01.12.2016 22:14
Danke dir für die Informationen Thomas.
Genau diese Präsentationen stehen nicht zum Download zur Verfügung.
Zitat:Du kannst aber, wie Gerd schon schrieb, alle VIs des aktuellen Projektes durchgehen und alle möglichen Informationen auslesen. Zum Beispiel kann man in jedem VI einen Kommentar mit allen Ein/Ausgängen anlegen, dazu Version, Datum, Autor etc. Wenn das in einer bestimmten Syntax erfolgt, kannst du das parsen und daraus eine schöne Doku erstellen.
Geanu das will ich. Ich kann aber Kommentare in VI's nicht außerhalb der LabView auslesen.( evtl. im Bild sehen von BD. Brauche ich aber nicht. Ich brauche Text. ) Wie ich es in LabView umsetzen kann, weiß ich noch nicht.( anscheinend diese VI-Scripting. Soll mich hier noch einarbeiten )
Danke für die Hilfe.
RE: LabView Dokumentation erzeugen - GerdW - 02.12.2016 08:35
Hallo aljasik,
Zitat:anscheinend diese VI-Scripting. Soll mich hier noch einarbeitenJa genau!
Im NI-Forum findest du die LabVIEW API Discussions mit Beiträgen zum Thema "VI Scripting"…
RE: LabView Dokumentation erzeugen - Morpheus - 02.12.2016 10:44
(01.12.2016 22:14 )aljasik schrieb: Genau diese Präsentationen stehen nicht zum Download zur Verfügung.
Die Präsentation zu den Bookmarks (Use #Bookmarks – Get Your Review Docs for Free!) findest du hier:
ftp://ftp.ni.com/pub/branches/switzerland/nidays/2016/LabVIEW_Software_Engineering/BibersteinDanielaNIDays2016slides.pdf
Es besteht aber die Möglichkeit, dass die Folien auf die VIP hin noch leicht angepasst wurden.
Gruss
Chris
RE: LabView Dokumentation erzeugen - aljasik - 09.12.2016 12:42
Danke für den Link.
Ich habe noch kurze Zusammenfassung für beide Präsentationen gefunden:
http://www.etz.de/files/040_biberstein-kubli.pdf
http://www.etz.de/files/041_hansen.pdf