7.11 Gestaltungsrichtlinien (Styleguide)
Hier sind einige Vorschläge, um Ihren Code lesbar zu halten.
Wie Sie vorher schon erfahren haben, unterscheidet Hollywood
nicht zwischen Groß- und Kleinschreibung. Aber um Ihren Code
lesbar zu halten, schlagen wir die folgenden Richtlinien vor:
- – Schreiben Sie Befehle immer so wie sie hier in der Dokumentation
erscheinen und beginnen Sie sie vor allem mit einem Großbuchstaben.
- – Schreiben Sie Konstanten in Großbuchstaben, um sie von
Variablen zu unterscheiden.
- – Schreiben Sie alle Präprozessor-Anweisungen in Großbuchstaben,
um sie als Deklarationen innerhalb Ihres Skripts herauszuheben.
- – Ein Befehl pro Zeile ist genug!
- – Benutzen Sie das "$"-Zeichen nur in Zeichenketten, um
Verwirrungen zu vermeiden.
- – Benutzen Sie das "!"-Zeichen nur in Fließkommazahlen,
um Verwirrungen zu vermeiden.
- – Ein paar Kommentare tun auch nicht weh.
- – Wenn Sie Schleifen, If()- sowie andere Blöcke benutzen,
sollten Sie mit Hilfe des Tabulators (oder mehreren Leerzeichen)
die verschiedenen Ebenen absetzen.
- – Sie sollten Ihre eigenen Funktionen mit einem "p_" beginnen,
um sie von Hollywood Befehlen unterscheiden zu können. Dies
vor allem, wenn sie englische Namen benutzen. Es könnte sein,
dass in Zukunft in Hollywood ein Befehl integriert wird, der
denselben Namen wie Ihre Funktion hat. Das kann dazu führen,
dass unerwartete Ergebnisse entstehen.
Navigation zeigen