Code & Style

  • Variablen

    Wie jeder aus eigener Erfahrung weiß, gibt es verschiedene Arten von Variablen bzw. Gültigkeitsbereiche in denen sie verwendet werden.
    So wie in der Gestaltung des gesamten Projektes, hat man auch hier die Namen willkürlich vergeben (ausser reservierte Wörter), trotdem sollte man sich an gewisse Regeln halten, um das Lesen einfacher zu gestalten und auch nachträglich zu wissen, wofür welche Variable verwendet wird.
Beispiele:
  • Variablen werden durchgängig klein geschrieben.
  • Variablen, die sich nur mit mehreren Wörten verständlich beschreiben lassen, werden mit Unterstrich geschrieben.
  • Die Namen sollen möglichst kurz und verständlich sein.
    Variablennamen mit der Länge von ein bis zwei Zeichen sollten nicht verwendet werden,
    da man sonst die Sinnhaftigkeit der selben nicht erkennt.
        Beispiel: $userID, $only_this

  • Temporäre Variablen, die zum Beispiel in Schleifen verwendet werden, sollten anderes Gekennzeichnet werden als solche die auch ausserhalb verwendet werden.
        Ein Beispiel dazu wäre: $_i

  • Klassen-Variablen, um auch diese gegenüber den "normalen" abzugrenzen, sollte man diese gesamt Groß schreiben
        Beispiel: $DB

  • Konstanten sollten durchgängig großgeschrieben werden
        Beispiel: SYSDIR
  • Argumente und Operatoren (+,-,...)

    Diese Elemente sollten jeweils mit einem Leerzeichen getrennt werden, um die Lesbarkeit zu erhöhen.

  • Funktions-Namen

    Funktion sollten beim durchlesen des Codes herrausstechen. Wie generell in dieser Sektion kann man dies auf seine eigene Art und Weise machen.
    Ich empfehle hier eine Kapitel-Schreibweise, d.h. Grosse Anfangsbuchstaben und Wörter die mit Unterstrichen verbunden sind
Beispiel:
FUNCTION Convert_Email ($str) {
    ....
}


| 1 | 2 | Vor |