PHP Coding Standard

Logo: PHP
12. Regel 9: Benennung von Variablen und Funktionen erfolgen mit Unterstrich und in Kleinbuchstaben

Wie schon erwähnt ist der Einsatz von Abkürzungen mit Vorsicht zu genießen. Es kann begründete Fälle geben, wo es sinnvoll ist, eine Abkürzung zu verwenden, aber die Regel "Benennung von Variablen und Funktionen erfolgen mit Unterstrich und in Kleinbuchstaben" soll den Einsatz von Abkürzungen zusätzlich erschweren. Das ist Absicht, denn Abkürzungen können einem Programmier-Team das Leben schwer machen - dazu später mehr.

Zitat aus "Einführung in Perl" von Randal L. Schwartz, Tom Phoenix und brian d foy, Seite 30
Ebenso können richtig platzierte Unterstriche das Lesen und Verstehen eines Variablennamens erleichtern, besonders dann, wenn der Programmierer, der Ihre Programme pflegen soll, einen anderen sprachlichen Hintergrund hat als Sie. So ist beispielsweise der Name $flachbett_scanner besser geeignet als $flachbettscanner, da sich Letzteres auch durchaus als $flach_bettscanner deuten lassen könnte. Bedeutet $stopid nun $sto_pid (»store process ID«, also Prozess-ID speichern), oder $stop_id (die ID für irgendetwas, das gestoppt werden soll), oder handelt es sich bloß um einen stupiden Rechtschreibfehler?

Wenn jeder im Team die Abkürzung RDBMS kennt, dann kann man sie auch verwenden. Um den Einsatz von Abkürzungen zu ermöglichen und Variablen eindeutig und mit mehreren Worten benennen zu können, benutzt man den Unterstrich zur Trennung der Wörter:

Gültig
   $customer_name = 'van Beek, Claus';
   $connect_rdbms = mysql_connect();

Kleinbuchstaben erleichtern die Suche nach Variablen. Einige Editoren und die meisten Linux-Systeme unterscheiden zwischen Groß- und Kleinschreibung. Sie arbeiten case-sensitive. Ein

grep "*skript_name*" ein_skript.php

führt dann auf jeder Plattform zum Erfolg (wenn es eine entsprechende Variable gibt). Heißt die Variable "$Skript_Name", wird der oben genannte Befehl fehlschlagen.