Naming Konventionen
Was beim Benennen von Variablen, Konstanten, Funktionen und Klassen eingehalten werden sollte, sind regeln zur Verwendung von Gross- und Kleinschreibung, sowie eine verständliche Benennung im Allgemeinen. Diese helfen der Leserlichkeit und Konstanz.
Konventionen haben keinen Einfluss auf deinen Code selbst, der Parser liest den Code so oder so, aber sowohl du, als auch ein Team, mit dem du vielleicht zusammenarbeitest, können den Code besser lesen, wenn sich alle an die selben Regeln halten. Ausserdem musst du nicht immer nachsehen, wie die Variable, die du ausgeben willst, vorher geschrieben wurde, wenn du dir eine Schreibweise angewöhnt hast. Viele Unternehmen mit eigener Entwicklungsabteilung einigen sich auf einen Standard, den du berücksichtigen musst, wenn du für sie arbeitest.
So geht's
1. Eindeutige und sinnhafte Benennung
Variablen, Funktionen und Klassen sollten eindeutig und unmissverständlich benannt werden, um Verwechslungen zu vermeiden. Die Eindeutigkeit bezieht sich sowohl auf das Verständnis (keine Abkürzungen) als auch auf die klare Erkennbarkeit des Inhalts (keine generischen, abstrakten Benennungen wie $a).
$student_id = $_GET['id']; // verständlich, OK
$a = $_GET['id']; // uneindeutig, nicht OK
function get_student_data ( ... ) // OK
function std ( ... ) // nicht OK
Funktionen und Variablen klein, Klassen Gross, Konstanten Upper Case
Die meisten Benennungen sind case-sensitive. Die konsequente Einhaltung der Gross-/Kleinschreibung bei jeglichen Benennungen hilft besonders beim schnellen und fehlerfreien Coden.
$student_id = $_GET['id'];
define ( "COOKIE_LIFETIME_DAYS", 7 );
function get_student_data ( $student_id ) { ... }
class StudentTable { ... }
Verschiedene Formen und Schreibweisen
Im Netz findet man diverse Beispiele von Code, in denen abgekürzte Schreibweisen zum Einsatz kommen. Weniger schreiben zu müssen klingt auf den ersten Blick verlockend. Insbesondere der PHP-Tag wird jedoch von den meisten Serverkonfigurationen nicht in der Kurzform akzeptiert und sollte deswegen nicht eingesetzt werden:
<?php // PHP code hier wird interpretiert
?>
vs:
<?
// PHP code hier wird sehr wahrscheinlich NICHT interpretiert!
?>
Es gibt hingegen andere Kurzschreibweisen, die durchaus verbreitet sind. Hier gilt: je kürzer und "formelhafter" Dein Code ist, desto weniger gibt es zu lesen, dein Code wird schlanker, aber auch schwerer zu lesen. Die Funktion der verschiedenen Schreibweisen unterscheidet sich nicht, und der Parser muss schlussendlich dasselbe tun, wähle deshalb die Form, die für dich gerade jetzt am besten funktioniert. Programmierer*innen, die ihren Code nicht verstehen, sind ein grösseres Hindernis als 2 Zeilen zusätzicher Code...
Einige Beispiele:
Ternärer Operator: diese Schreibweise verkürzt IF/ELSE, die je nach Situation einen anderen Wert definieren sollten, auf eine Zeile. Du kannst dies für Variablendefinitionen, aber auch für Rückgabewerte in Funktionen nutzen. Du findest eine komplette Beschreibung aller Möglichkeiten in diesem Artikel (englisch)
// IF/ELSE
if( strlen( $input )>0 ){
$eingabe = $input;
}else{
$eingabe = 'keine Eingabe';
}
// Ternary Operator
$eingabe = strlen( $input )>0 ? $input : 'keine Angabe';
Kurzform für echo: echo ist sicher der häufigste Befehl in deiner dynamischen Webseite. Daher gibt es diese Kurzform, welche dir noch ein paar Zeichen erspart.
<!-- normale ausgabe -->
<h1><?php echo $titel; ?></h1>
<!-- Kurzform -->
<h1><?=$titel ?></h1>Tips und Links
Gewöhne dir verständliches, nachvollziehbares Naming an.