Hallo
bislang hatte ich häufig direkt in fhem.cfg dokumentiert.
Jetzt möchte ich - wie empfohlen - nur mit dem DEF-Editor arbeiten und auch dort dokumentieren. Es gibt wohl die beiden Möglichkeiten
- ## hinter einem Befehl
- # (STRFG + Q) am Anfang einer Zeile
Ich blicke jedoch nicht genau durch, welche Regeln zu beachten sind, da ich unter bestimmten Voraussetzungen einen Syntax-Fehler erhalte. So z.B. wenn ich einen Befehl hinter einer geschweiften Klammer dokumentieren möchte
2015.11.17 12:08:30 3: nt_Sonnenertrag_Status return value: Unknown command {
my, try help.
Unknown command #, try help.
Unknown command }Füge ich den Kommentar vor der } ein, so gi bt es keinen Fehler!
Auch bei ## muss wohl etwas zu beachten sein.
Kann bitte einer definieren, was bei den beiden Varianten zur Dokumentation zu beachten ist.
Danke
Jürgen
ZitatKommentare in Perl (‽)
Wie jede bessere Programmiersprache erlaubt Perl das Notieren von Kommentaren. Kommentare werden nicht als Code interpretiert, sondern erläutern das Programm oder machen den Code für den Programmierer besser lesbar.
Beispiel
# es folgt die Ausgabe der Quadratzahlen
# von 1 bis 99
for my $i (1..99) {
# Hier wird das Quadrat der Zahlen ausgegeben
print "Das Quadrat von $i ist " . $i * $i . ".\n";
}
Kommentare in Perl beginnen mit einem Nummernzeichen #. Alles, was hinter dem Nummernzeichen bis zum Ende der Zeile steht, wird von Perl ignoriert. Beginnt eine Zeile mit dem Nummernzeichen, ist die gesamte Zeile ein Kommentar.
Neben der einfachen Auskommentierung besteht auch die Möglichkeit, größere Abschnitte des Programms als Dokumentation auszuweisen. Solche Dokumentationen können mit dem Programm perldoc, das zum Lieferumfang der Perl-Distribution gehört, separat gelesen werden. Bei komplexeren Programmen können Sie so die Dokumentation gleich zum Programm mit dazuliefern. Im Zusammenhang mit Modulen wird im Abschnitt Moduldokumentationen lesen mit perldoc beschrieben, wie solche Abschnitte aussehen. Was dort für Module beschrieben wird, funktioniert in jedem Perl-Programm.
Quelle: https://wiki.selfhtml.org/wiki/Perl/Einf%C3%BChrung
Ich denke aber nicht, dass das im DEF Editor eine gute Idee ist. Wenn Code so komplex ist, dass er kommentiert werden muss, gehört er, meiner Ansicht nach, als sub in die myUtils.
o.k.
vielen Dank