+- LabVIEWForum.de (https://www.labviewforum.de)
+-- Forum: LabVIEW (/Forum-LabVIEW)
+--- Forum: LabVIEW Allgemein (/Forum-LabVIEW-Allgemein)
+--- Thema: Dokumentieren und Kommentieren aber wie? (/Thread-Dokumentieren-und-Kommentieren-aber-wie)
Dokumentieren und Kommentieren aber wie? - sifiland - 24.06.2005 15:47
Hallo Alle Zusammen,
ich habe jetzt ein schönes Prüfprogramm besteht aus mehreren SubVIs erstellen ( wie kann ein Programm schön sein ohne Doku?)
Die Frage ist, wie kann ich sinnvoll und nachvollziehbar dokumentieren, wenn ich nach 6 Monaten wieder lese, auch verstehen kann, was ich alles gemacht habe.
Könnt ihr mir Tips und Triks geben oder besser ein gut dokumentiertes Programm / VI posten.
Ich wünsche allen ein schönes Wochenende.
Dokumentieren und Kommentieren aber wie? - DuranDC - 25.06.2005 14:04
Das würde mich auch interessieren, besonders Beispiele von Dokumentierten Codes.
Das einzige, was ich dir derzeitig anbieten kann in der richtung wäre das, was LabVIEW selber fabriziert (unter Datei-Drucken-weiter-vollständige Hierachie)
Dokumentieren und Kommentieren aber wie? - Oliver Listing - 26.06.2005 20:52
Hi sifiland,
Also zunächst empfehle ich die Möglichkeiten von LabVIEW auszunutzen:
1. alle Frontpanel-Elemente können über einen rechten Mausclick unter Description and Tip... beschrieben werden.
hier schreibe ich schon mal rein wofür die Daten sind und welche Zeilen und Spaltenüberschriften das Array hat.
2. jedes VI kann ebenso beschrieben werden: Strg+I Dokumentation
Hier gehört rein, was das VI macht. Ruft es lediglich weiter Sub-VIs auf und übergibt dazu die Daten, so kann dies ggf. entfallen, da ja die Sub-VIs Dokumentiert sind. (selten der Fall)
3. beschreibenden Text im VI plazieren:
Nicht nur in Schleifen oder Case-Strukturen einen beschreibenen Text einfügen, sondern auch zwischendurch. Wahrheitstabellen, die für die Dezimierung von ev. vorhandener boolischen Logik verantwortlich sind gehören ebenso hinein, wie Beschreibung ev. Hardwarezugriffe.
Das Hierachy Window von LabVIEW bietet nur bei kleinen Programmen noch den nötigen Überblick. Erschwerend kommt hier hinzu, das sich die Anordnung der VIs in den einzelnden Schichten nicht speichern läst. Das führt dazu, das sie meißt (99,9%) nicht sinnvoll geordnet sind.
Wir haben uns hier (nicht nur zur Dokumentation) für die Softwareentwicklung nach den Regeln der SD (Structured Design) entschieden (für die SA fehlt das Personal) dort wird das Projekt/Programm im Vorwege auf die Beine gestellt. Diese Ergebnisse werden u.a. in sog. Operationsdiagrammen dargestellt, welche eben dem Hierachy Window von LabVIEW stark ähneln.
Wesentlicher zusätzlicher Bestandteil der Dagramme sind die Darstellung des Datenflusses.
In dem eingesetzten CASE Tool finden sich die Beschreibenden Texte der Frontpannel-Elemente und der VIs wieder, so daß sie in einer Zusammenhängenden Dokumentation stehen.
Gruß
Oliver
Dokumentieren und Kommentieren aber wie? - sifiland - 27.06.2005 14:14
Danke erstmal für die Antworten
Oliver, kannst du ein Biespiel für SD posten.