Kommentierung schreiben

HorstPower

Level-1
Beiträge
19
Reaktionspunkte
0
Zuviel Werbung?
-> Hier kostenlos registrieren
Moin ich hab da so ein kleines Problem und zwar hab ich nen kleines Programm geschrieben das noch Kommentiert werden muss. Mein Problem ist das ich nicht so wirklich weiß was in die Kommentarzeile rein soll. Also ich hab jetzt so was geschrieben wie z.B.

Merker M1.0 ist Aktiv so lange der Überstromauslöser F3 nicht auslöst.

oder

Das Schütz K1 zieht an wenn der Merker 2.0 aktiv ist und die Quittierung nicht aktiv ist.
Das Schütz K1 fält ab wenn der Taster S1 betätigt wird oder der Merker 3.0 aktiv ist.

Ist das so richtig oder was schreibt man in die Kommentarzeile??

Danke schon mal für eure Hilfe!!!
 
ich würde dir erst mal empfehlen die symboltabelle anzulegen. dann kannst d hier schon mal die meisten Kommentare sparen, was das für ein merker ist, was der eingang/ausgang macht... dann brauchst du nur noch einen kurzen kommentar zur funktionsweise des programmes schreiben...
 
Zuviel Werbung?
-> Hier kostenlos registrieren
eine Symboltabelle habe ich angelegt.
Also würde man für Beispiel 1 kein Kommentar schreiben?? Weil ich einfach nur nen Eingang habe UND der auf einen Merker geht.

Und Beispiel 2:
Motor starten durch den Taster S1
 
Es gibt ja mehrere Ebenen zum kommentieren.

1. Der Symbolkommentar:
--> hier kommentierst Du, was dieses Signal macht, z. B. A1.0 = Netzschütz

2. Der Netzwerküberschrift /-kommentar:
--> Hier kannst Du angeben, was dieses Netzwerk macht.

3. Der Bausteinkommentar:
--> Bei der Verwendung mehrerer Bausteine, was ja häufig die Regel ist, macht eine Benennung des Bausteins sinn, sowie bei universellen Bausteinen auch eine etwas ausführlichere Beschreibung der Funktion.
 
sowie bei universellen Bausteinen auch eine etwas ausführlichere Beschreibung der Funktion.

und nicht zu vergessen eine ausführliche schnittstellenbeschreibung!

ansonsten gilt: wenig prosa! es ist beim programmieren nicht wie in der schule, man muß nicht im ganzen satz beschreiben...

und @MCerv: 4. der zeilenkommentar! ...sinnvoll um berechnungsschritte zu beschreiben ... funktioniert aber "nur" in AWL und SCL :ROFLMAO:
 
Nicht nur Kommentare machen ein Programm lesbar, sondern auch vernünftige Merkernamen.
Z.B.:
"Merker M1.0 ist Aktiv so lange der Überstromauslöser F3 nicht auslöst."
M1.0 mit Symbolnamen "Ueberstrom_F3_Ok" versehen.
So wird der Programmcode an sich schon fast selbsterklärend.

Das Gleich gilt für Ein- und Ausgänge:
"Motor starten durch den Taster S1"
E1.0 wird zu "Motorstarter_S1"
A1.0 wird zu "Motor M1 starten"

und damit wird aus einem.
U M1.0
U E1.0
= A1.0
ein
U "Ueberstrom_F3_Ok"
U "Motorstarter_S1"
= "Motor M1 starten"

Das braucht (fast) keinen Kommentar mehr.

Und das noch in FUP (wer's mag), dann ist es wirklich selbsterklärend.
 
Zuletzt bearbeitet:
Nicht nur Kommentare machen ein Programm lesbar, sondern auch vernünftige Merkernamen.
Z.B.:
"Merker M1.0 ist Aktiv so lange der Überstromauslöser F3 nicht auslöst."
M1.0 mit Symbolnamen "Ueberstrom_F3_Ok" versehen.
So wird der Programmcode an sich schon fast selbsterklärend.

Wenn Du mal oben gelesen hättest, wurde der Symbolkommentar sogar als erstes hier erwähnt!
 
Zuviel Werbung?
-> Hier kostenlos registrieren
Richtig: Ich wollte es nur noch etwas veranschaulichen, da noch eine weitere Frage kam, bzgl. der Kommentierung. Ich hatte den Eindruck, es war nicht ganz so klar.
 
Zuletzt bearbeitet:
Jo danke das hat mir echt viel geholfen jetzt weiß ich was ich da rein schreiben soll in der Schule lernt man so was ja nicht...
 
Das mit den Kommentaren ist eh immer so ne Sache.
Oft spricht die Zuweisung für sich und vieles wird somit doppelt geschrieben!
Bzw. in der Symbolik wurde als Kommentar das selbe geschriebn wie der Zeilenkommentar ...

Viel wichtiger wäre da ein gescheiter Netzwerkkommentar und eine Aussagekräftige Überschrift fürs Netzwerk, sowie aktuelle Symboltab..
 
Zurück
Oben