Wie kommentiere ich richtig?

[obeis]

Moin Zusammen

Wie Ihr Vielleicht in meinem Thread [url]62377[/url] gelesen habt will Ich meine Anlage in Ruhe offline neu programmieren.
Die Übersicht steht und fällt mit den vorhandenen Komentaren.

Man muss bei der begrenzten Anzahl mit Abkürzungen arbeiten. Aber wie macht man es richtig, damit man selber durchsteigt und auch jemand anders mit wenig suchen klar kommt.

Wer von euch würde vielleicht mal eine kleine Standart Funktion mit passenden Kommentaren hier z.B. als Bild oder als LP3 Datei rein stellen?
Ich denke da an sowas wie ein Flur mit BMI und Einzelraumregelung.
Ich hoffe das Mir jemand helfen kann und das das vielleicht auch noch anderen Neueinsteigern hilft.

Danke im Voraus

Siebo

[Penrose]

Also ich will immer fleißig kommentieren und mir reichen die wenigen Zeichen so gut wie nie aus. Daher dokumentiere ich zusätzlich in der "Use Case"-Art und Weise, d.h. ich beschreibe verbal, was ich aus Benutzersicht will und beschreibe dann, was ich dafür programmiert habe. Das hat natürlich den riesigen Nachteil, dass es auseinander laufen kann (was auch schon passiert ist) und es sehr viel Disziplin braucht, das auf dem Stand zu halten. Im Laufe der Zeit muss ich aber sagen, dass ich so oft von der Doku profitiert habe, dass mir das direkte Dokumentieren nicht mehr schwerfällt. Aber das ist sicher nicht jedermanns Sache.

Als Tool nutze ich Evernote, was den Vorteil hat, dass ich auch meine Ideen und Gedanken quasi jederzeit festhalten und prüfen kann, z.B. wenn man mal nicht einschlafen kann oder sich die beste Frau von allen beschwert, dass was nicht geht.

Hier ein Beispiel:
Wenn Markisenautomatik aus, dann fährt die Markise nur noch bei Sturm automatisch ein
Markisenautomatik ein -> M020 R8 ein -> Taste M020 C8 Lang -> Entsperre Tasten M202 C8 (Markise rein bei Regen) und entsperre M020 Taste B8 (Markise automatisch rausfahren)
Markisenautomatik aus -> M020 R8 aus -> Taste M020 C8 Los -> Sperre Tasten M202 C8 (Markise rein bei Regen) und sperre M020 Taste B8 (Markise automatisch rausfahren)

Sonnenschutzbeginn fährt Wohnzimmer-Rollläden nur runter, wenn Markisenautomatik aus und Markise nur raus, wenn Markisenautomatik ein
Markisenautomatik ein -> M020 R8 ein -> Taste M020 C8 Lang -> Sende M020 Taste D1 Lang -> Sperre M020 Taste B3+4 (Wohnzimmerrollläden) und entsperrt M020 Taste B8 (Markise)
Markisenautomatik ein -> M020 R8 ein -> Taste M020 C8 Lang -> Sende M020 Taste D2 Lang -> Wiederhole M060 B6 (Terrassentür)
Markisenautomatik aus -> M020 R8 aus -> Taste M020 C8 Los -> Sende M020 Taste D1 Los -> Entsperre M020 Taste B3+4 (Wohnzimmerrollläden) und sperrt M020 Taste B8 (Markise)
Markisenautomatik aus -> M020 R8 aus -> Taste M020 C8 Los -> Sende M020 Taste D2 Los -> Wiederhole M060 B6 (Terrassentür)

Thomas

[Beleuchtfix]

@Thomas, bist du Schriftstelle? Genial, aber da sind sicherlich die meisten zu faul. Bei einer Kundenanlage muss man die Kommentare dann auch immer mit ausliefern (am besten auch gedruckt), sonst hat der auch nichts davon.

Mit der 5er Pro kann man im Namen schön eine Struktur erstellen, das versuche ich schon zu benutzen und habe meine Module alle umbenannt. Wie die eigentlich Struktur ist, bleibt einem selber überlassen.

Abkürzungen wie EG, WZ etc. sparen Buchstaben und sind hinreichend übersichtlich, komplexe Logiken muss man ausführlicher beschreiben, da kann auch manchmal ein extra Blatt (sie oben) sehr hilfreich sein.

Gruß
Florian, dessen Anlage auch historisch falsch gewachsen ist

[hocky]

Moin,
spannende Frage, interessiert mich auch da mittlerweile meine (eigene) Anlage wächst und gedeiht.
Den Use Case Ansatz von Thomas finde ich super - Du bist Softwareentwickler, oder?
Hilft auch enorm bei der Anforderungsaufnahme - einfach mal aus Usersicht dokumentieren was passieren soll.
Dazu gehört aber trotzdem noch die technische Umsetzung und deren Dokumentation, das zu vermengen finde ich schwierig.
Ich bin über weitere Anregungen gespannt.
VG, Hocky

[Sven]

@Thomas, bist du Schriftstelle?

Neee

Schriftsteller ist gut, oder Thomas?

[Beleuchtfix]

Sch... jetzt kann ich das nicht mal mehr korrigieren.
Gruß
Florian

[Penrose]

Den Use Case Ansatz von Thomas finde ich super - Du bist Softwareentwickler, oder?

In grauer Vorzeit, ja. Inzwischen fühle ich mich in der Tat manchmal mehr als Schriftstelle denn als Schriftsteller

Dazu gehört aber trotzdem noch die technische Umsetzung und deren Dokumentation, das zu vermengen finde ich schwierig.

Wie meinst du das? Wenn du damit die Verknüpfung der LCN-Parametrierung mit den Use Cases meinst, finde ich genau das gerade gut. Allerdings muss ich zugeben, dass purer Text dafür mitunter an seine Grenzen stößt, wenn z.B. mehrere Use Cases in einer Programmierung abgedeckt werden. So kommt es schon mal zu Redundanzen - iiiiih