TIA Was gehört in eine Ordentliche Dokumentation

[aktar80]

Zuviel Werbung?
-> Hier kostenlos registrieren

Hallo zusammen,

mein erstes Eigenes Projekt ist fast fertig. So langsam muss ich mir Gedanken über eine Dokumentation machen. Leider weiss ich nicht was da alles reingehört. Desweiteren würde ich gerne Mein Programm erklären (für den nächsten der da dran arbeiten soll). Also jedes einzelene Netzwerk. Habt ihr da ein Paar Ideen. Wie wird sowas gemacht? und wie macht ihr das.

LG Aktaro

 

[Fabpicard]

Dafür nutzt man doch eigentlich den Netzwerktitel sowie wenn nötig auch die Netzwerkkommentar-Funktion, das schon während man das Programm schreibt, weil man sich selbst dann besser zurecht findet...

Ich lasse die Kommentare dann weg, wenn der Titel schon alles zu dem Netzwerk sagt. Selbst wenn nur ein FC aufgerufen wird, dann packt man in den Titel halt die "Langversion" rein.

Ist der Inhalt in dem Netzwerk so groß, dann kommentiert man schön viel innen drin.
(Denn du kannst fast nicht zu viel, aber schnell zu wenig Kommentiert haben )

MfG Fabsi

 

[Blockmove]

Zuviel Werbung?
-> Hier kostenlos registrieren

Hallo zusammen,
mein erstes Eigenes Projekt ist fast fertig. So langsam muss ich mir Gedanken über eine Dokumentation machen. Leider weiss ich nicht was da alles reingehört.

Also eigentlich ist das - in meinen Augen - die falsche Vorgenhensweis.
Die Doku fängt schon vor dem eigentlichen Programmieren an.
Aussagekräftige Symbole und Symbolkommentare sind der 1. Schritt.
Dann eine klar gegegliederte Bausteinstruktur.
In den Bausteinen sprechende Variablennamen inkl. Kommentar.
Variablennamen wie "HVar1 - Hilfsvariable 1" bringen nix.
Netzwerktitel und Zeilenkommentare gehören dazu.
Zeilenkommentare sollten sinnvoll sein.
Ein Zeilenkommentar wie "Beginn Schleife" bei einer For-Anweisung ist sinnlos.
Als Programmierer sehe ich, dass For eine Schleife ist.
Wenn du Schrittketten nicht in Graph programmierst, dann ist ein Ablaufdiagramm hilfreich.

Gruß
Blockmove

 

[Senator42]

vor allem KORREKTE Texte. wird nach kopieren gern vergessen anzupassen.

zum eigentlichen Programm kommt noch hinzu:
Schaltplan
Aufbauplan, wo sind welche Teile
Parameter von Baugruppen (Frequenzumrichter, I/O-Periferie, HMI)
CPU-Einstellungen, die kein Standart sind (LAN, Gateway, Timeserver

Fehlerliste und was man dann tun muss
Bsp: 10B1 Luftdruck zu gering: Luftversorgung am Hahn xx beim Träger zz prüfen