10.5. Syntax von Kommentaren
Jede Funktion sollte einen Blockkommentar bekommen, der Name, Ein/Ausgabe und die Aufgabe der Funktion enthält.
Idealerweise sollte jedem Codebereich wie while, if, for oder Ähnlichem ein Kommentar vorangestellt sein, der beschreibt, was in diesem Bereich passiert. Manchmal können Sie darauf verzichten.
Beispiel 10.7. Kommentar für while, if, for
// Retry while there is no connection
while($index < count($hosts) && $connection == false) {
if(strstr($hosts[$index], ":"))
Erklären Sie Codebereiche, deren Zweck nicht offensichtlich ist.
Beispiel 10.8. Kommentar für komplizierte Codebereiche
// remove all leading spaces, tabs and carriage returns NOT
// preceeded by a php close tag.
$source = trim(preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source));
