Kommentare in der Programierung

[obeis]

Moin zusammen.

Wie kommentiert Ihr eure Anlagen?
Gibt es gute sinvolle Abkürzugen?
Ich habe bisher fast alles im klartext beschriftet. Dadurch bin ich aber schon in diversen Modulen am Ende, obwohl nur die Hälfte der Funktionen genutzt werden. Ich kann mich auch nur schlecht festlegen wie weit in die Tiefe ich überhaupt kommentieren sollte.
Könnte Ihr mal ein repräsentatives Beispiel hier einstellen? Mir geht es nicht um die eigentliche Funktion sondern nur um die Kommentare.

Ich bin gespannt auf Antworten. Danke schon mal.

Siebo

[Uwe]

Moin Siebo,
natürlich gibt es sinnvolle Kürzel - schau dir doch nur mal die Modulbezeichnungen vom LCN an
Nein, ernsthaft. Die von mir verwendeten Kürzel habe ich auch schon bei anderen Kollegen gefunden.
Ein 'STV BMI WZ.D1' sollte so klar sein, auch eine Tasterbezeichnung vom T8 kommt mit o.re oder u.lks.o immer deutlich genug rüber (die Funktion kann ich dann meist über den programmierten Aktor nachvollziehen).

LG, Uwe

[Thomas.Einzel]

Moin zusammen.

Wie kommentiert Ihr eure Anlagen?
Gibt es gute sinvolle Abkürzugen?
Ich habe bisher fast alles im klartext beschriftet. Dadurch bin ich aber schon in diversen Modulen am Ende, obwohl nur die Hälfte der Funktionen genutzt werden. Ich kann mich auch nur schlecht festlegen wie weit in die Tiefe ich überhaupt kommentieren sollte.
Könnte Ihr mal ein repräsentatives Beispiel hier einstellen? Mir geht es nicht um die eigentliche Funktion sondern nur um die Kommentare.

Ich bin gespannt auf Antworten. Danke schon mal.

Siebo

Viel Platz sparen kann man mit CamelCase in Abkürzungen. Statt Ta.Wohnz.Tür-links ->TaWzTürLin oder TaWzTürLi oder da es ohnehin bei einem Taster steht: WzTürL nur 1/3 des ursprünglichen Platzes (5 statt 18)

Wenn man generell kein Wort "Licht" verwendet, sondern z.B La(mpe) reicht auch Li für links und La für Lampe, auch L und R geht, wenn man das durchgängig macht, L ist links und La ist Lampe z.B. Das alles mit der Häufigkeit bringt schon ein bisschen. Ich empfehle dir eine Art generelles Abkürzungsverzeichnis, "immer gleich" prägt ein. Wer statt Roll oder Ro immer Rollladen (o.ä.) schreibt, ist mit dem Kommentarplatz schnell am Ende.

Thomas

[LCNJürgen]

Also wenn man aber zu viel Abkürzt dann weis ein anderer wieder nicht was man damit gemeint hat!

[obeis]

Das könnte wieder die Firewall sparen

[Thomas.Einzel]

[zitat=LCNJürgen]Also wenn man aber zu viel Abkürzt dann weis ein anderer wieder nicht was man damit gemeint hat![/zitat]

Hm, also ist es besser den Kommentar mangels Platz nach der Hälfte der Funktionen wegen "Platz zu Ende" gar nicht zu haben?

Finde ich etwas komisch.

P.S. Wenn man ein durchgängiges Abkürzungsverzeichnis hat, kann man das zum Verständnis für andere auf die Innenseite der UV Tür mit dem PK(U) kleben.

Thomas

[LCNJürgen]

So mal eine kleine Anlage zum schauen wie ich es so mache!

[obeis]

Moin Moin

Danke für das Beispiel. Aber das maht mir gerade etwas Angst. bei 300Moduen habe ich nicht mehr weiter gerechnet. Was bitte ist dann eine große Anlage?
Ich fand meine 20 Module schon nicht schlecht.
Wie groß sind den hier die größten betreuten Anlagen der BusProfi Mitglieder? Ich will ja nicht neugierig sein aber das interesiert mich schon.

Siebo

Siebo

[LCNJürgen]

Ja es sind nicht alle Standorte miteinander Verknüpft bisher wo noch kommen soll!
Die fehlen bei der Datei ja noch!

[Beleuchtfix]

@Thomas,
irgendwo muss man immer Kompromisse eingehen. Eine Grundbeschriftung ist immer möglich. Je mehr wir in die Module quetschen, desto unübersichtlicher wird natürlich auch alles. Sinnvolle Abkürzungen ohne AKüFi (Abkürzungsfimmel) muss man dann schon verwenden. Hier ist jeder erst mal für seine eigen Installation verantwortlich.

Wenn die Abkürzungen durchgängig sind (das muss man dann schon etwas vorher planen, die CamelCase Methode spricht mich sehr an, kommt man schon sehr weit. Außerdem kannst du ja auch eine Abkürungsliste mit zur normalen Elektro-Dokumentation heften.

Wenn du trickreich (über Module hinweg, Tasten verdoppeln oder Logik auslagern, weil bei Modul xxx noch die Taste C7 kurz frei ist) programmierst, wie wir Häuslebauer das aus Spargründen gerne machen, dann solltest du das richtig gut (auch extern) dokumentieren, denn sonst kämpfst du dich bei jeder kleinen Änderung wieder durch deine Gedanken von vor x Jahren.

Viel Spaß beim Erdenken sinnvoller Abkürzungen
Florian