Originally posted by: <email address deleted>
Hallo,
vielleicht setzte ich mich mit dem Beitrag in die Nesseln, was mir auffällt
ist, das der Perlcode in vielen CodeSnippets im FHEMWiki nicht Kommentiert
ist. Ich finde es manchmal schwierig durch zublicken. Klar nach einer Weile
geht es immer, aber ich würde mir Wünschen, das die CodeSnippets mit
Kommentaren versehen werden, gerade wenn man nicht gut Perl kann, hilft das
doch ungemein auch einen Code für andere Aufgaben zu "missbrauchen" bzw. zu
verstehen.
Mal 2 Beispiele:
Unkommentiert:
http://www.fhemwiki.de/wiki/FritzBox_Parameter_in_fhem_anzeigen
(Teilweise)Kommentiert:
http://www.fhemwiki.de/wiki/Netzwerkger%C3%A4te:_Verf%C3%BCgbarkeit_pr%C3%BCfen
Wie geht das euch? Klar verlangen kann ich das nicht und wenn da einer
keine Lust zu hat, kann ich das verstehen. Ich trau mich allerdings selber
nicht, fremden Code zu kommentieren. Aber ich finde auch das Kommentare
einfach dazu gehören, ich mach das bei mir z.B. damit ich einfach selber
wenn ich nach 2 Jahren noch mal auf den Code schaue, schneller wieder drin
bin.
Bin auf eure Meinungen gespannt
Grüße
strauch
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com
einige der Beispiele sind augenscheinlich mehr für Fortgeschrittene
gedacht, die keine detaillierte Erklärung mehr benötigen. Grundsätzlich
gebe ich Dir aber recht, ein paar mehr erklärende Worte zum "warum" wären
sicher nützlich, gerade auch, wenn man daran denkt, den Funktionsumfang zu
erweitern.
Über den Grad der Kommentierung läßt sich aber auch schon wieder streiten:
Wenn ein umfangreiches Modul wie z.B. das mit den Parametern in "Häppchen"
serviert wird, unterbrochen von erklärenden Absätzen, kann man es nicht
mehr mit Copy'n'Paste übernehmen. Von daher bevorzuge ich persönlich eher
eine allgemeine Beschreibung zu Sinn und Zweck darüber, und am Ende ggf.
Kommentare zu einzelnen Funktionen und deren Realisierung.
Trotzdem sollte man den Standard nicht zu hoch hängen, ich bin heilfroh,
dass findige Tüftler überhaupt was einstellen, das man nutzen oder gar
weiter einwickeln kann. Ich denke nicht, dass die Autoren was dagegen
haben, wenn jemand Kommentare ergänzt. ;-)
Gruß
Torsten
Am 29. Oktober 2012 09:14 schrieb strauch
:
> Hallo,
>
> vielleicht setzte ich mich mit dem Beitrag in die Nesseln, was mir
> auffällt ist, das der Perlcode in vielen CodeSnippets im FHEMWiki nicht
> Kommentiert ist. Ich finde es manchmal schwierig durch zublicken. Klar nach
> einer Weile geht es immer, aber ich würde mir Wünschen, das die
> CodeSnippets mit Kommentaren versehen werden, gerade wenn man nicht gut
> Perl kann, hilft das doch ungemein auch einen Code für andere Aufgaben zu
> "missbrauchen" bzw. zu verstehen.
>
> Mal 2 Beispiele:
> Unkommentiert:
> http://www.fhemwiki.de/wiki/FritzBox_Parameter_in_fhem_anzeigen
> (Teilweise)Kommentiert:
>
> http://www.fhemwiki.de/wiki/Netzwerkger%C3%A4te:_Verf%C3%BCgbarkeit_pr%C3%BCfen
>
> Wie geht das euch? Klar verlangen kann ich das nicht und wenn da einer
> keine Lust zu hat, kann ich das verstehen. Ich trau mich allerdings selber
> nicht, fremden Code zu kommentieren. Aber ich finde auch das Kommentare
> einfach dazu gehören, ich mach das bei mir z.B. damit ich einfach selber
> wenn ich nach 2 Jahren noch mal auf den Code schaue, schneller wieder drin
> bin.
>
> Bin auf eure Meinungen gespannt
>
> Grüße
>
> strauch
>
> --
> To unsubscribe from this group, send email to
> fhem-users+unsubscribe@googlegroups.com
>
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com
Originally posted by: <email address deleted>
Du meinst eher in der Art wie das hier:
http://www.fhemwiki.de/wiki/Heizungskontrolle_Einfach
Vielleicht überarbeite ich einfach die Kommentare von den CodeSnippets die
ich selber umsetzte. Wie gesagt ich will das auch nicht hoch anhängen, ich
finde es nur bei den Codes schwer die Ellenlang sind und kaum oder nichts
erklärt wurde.
Sich in FHEM einzuarbeiten ist halt auch einfach etwas "arbeit" :-).
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com
Als sehr schön dokumentiertes, aber schlecht kopierbares Beispiel, ja. ;)
Vielleicht wäre es sonst zweckmäßig, den Code 2x im Artikel zu haben:
1x als Kopiervorlage, 1x komplett mit Doku...?
Am 29. Oktober 2012 11:53 schrieb strauch
:
> Du meinst eher in der Art wie das hier:
> http://www.fhemwiki.de/wiki/Heizungskontrolle_Einfach
>
> Vielleicht überarbeite ich einfach die Kommentare von den CodeSnippets die
> ich selber umsetzte. Wie gesagt ich will das auch nicht hoch anhängen, ich
> finde es nur bei den Codes schwer die Ellenlang sind und kaum oder nichts
> erklärt wurde.
> Sich in FHEM einzuarbeiten ist halt auch einfach etwas "arbeit" :-).
>
> --
> To unsubscribe from this group, send email to
> fhem-users+unsubscribe@googlegroups.com
>
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com
Originally posted by: <email address deleted>
Stimmt, aber wenn sich keiner beschwert, wenn ich etwas in den
Wikieinträgen rumfuhrwerke, werde ich bei solchen Dingen den Komplettcode
drunter hängen und andere um Erklärungen erweitern, aber immer nur wenn ich
das nutze.
Achja vielen Dank für deinen CodeSnippet zum FHT80b Automatik Temperatur
setzten, den habe ich gestern eingebaut und meine Heizung angeworfen und
hat direkt funktioniert. Wobei ich schon seltsam finde, wechsel ich am
FHT80b zwischen Manuell und Auto wechselt er auch die Temperatur über "set
Heizung mode auto" macht er es nicht.
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com
> Stimmt, aber wenn sich keiner beschwert, wenn ich etwas in den
Wikieinträgen rumfuhrwerke, werde ich bei solchen Dingen den Komplettcode
drunter hängen und andere um Erklärungen erweitern, aber immer nur wenn ich
das nutze.
Da sich noch kein Admin zu Wort gemeldet hat, scheint es zumindest nicht
gegen Style-Guides ;) o.ä. zu verstoßen. Also nur zu!
> Achja vielen Dank für deinen CodeSnippet zum FHT80b Automatik Temperatur
setzten, den habe ich gestern eingebaut und meine Heizung angeworfen und
hat direkt funktioniert.
Das hört man gern. =8)
> Wobei ich schon seltsam finde, wechsel ich am FHT80b zwischen Manuell und
Auto wechselt er auch die Temperatur über "set Heizung mode auto" macht er
es nicht.
Tja - genau DAS war der Grund, warum ich das Schnipselchen "erfinden
musste"!
Gruß
Torsten
--
To unsubscribe from this group, send email to
fhem-users+unsubscribe@googlegroups.com