Sie sind hier: Startseite -> PHP-Grundlagen -> Kommentare

Kommentare im PHP-Code

Sich durch Kommentare bei PHP selbst helfen

Also hat man alles, was man braucht, verstanden und legt mit den ersten Skripten unter PHP los. Die Dateien werden auf den Server geladen und voilá, die Webseite funktioniert. Sie funktioniert sogar besser als man angenommen hatte und schon bald erweitert man die Webseite mit neuen Möglichkeiten.

Irgendwann kommt dann der Punkt, an dem es schwierig wird, weil man sich nicht mehr erinnern kann, was jetzt zu welcher Funktion gehört und wo welche Datei warum eingebunden werden muss. Eine Dokumentation wurde nicht geschrieben - wozu auch? Und schon hat man das Problem, dass man Erweiterungen in Form von Ratespielen durchführen muss.

Kommentare können weiterhelfen

Noch schlimmer wird es, wenn man ein Projekt übernimmt, das von jemand anders programmiert wurde. In all diesen Fällen rächt es sich, wenn es keine Kommentare gibt. Diese können nämlich jederzeit und mühelos in den Quellcode eingebaut werden und scheinen anfangs Zeitverschwendung zu sein, sind aber sehr nützliche Hilfequellen, wenn man ein halbes Jahr später etwas erweitern oder korrigieren will.

<?php
// mit $vorname wird der Vorname aus dem Formular übernommen
$vorname = $_POST["vorname"]; // Kommentar hinter dem Befehl

/* 26. September 2008: In der Webseite soll nur ein Name stehen.
Aus dem Formular kommen aber vorname und name getrennt, daher wird hier verknüpft. */
$name = $vorname." ".$nachname;
?>

Im ersten Beispiel wurde mit // ein einzeiliger Kommentar eingebaut, der eine Information über die folgende Variable liefert. Das Beispiel liefert auch eine Demonstration, dass man diesen einzeiligen Kommentar hinter dem Befehl anbringen kann. Dann gibt es mit /* die Eröffnung eines mehrzeiligen Kommentars, der mit */ abgeschlossen wird.

Kommentare in der Praxis

Beide Kommentararten werden in PHP sehr häufig verwendet und zwar ironischerweise mehr von den Profis als von den Anfängern, obwohl es eigentlich umgekehrt sein sollte. Die Profis haben aber erkannt, wie wichtig diese Kommentare sind, die es nur im Skript gibt. Das heißt, dass die oben dargestellten Kommentare auf der Webseite nicht zu finden sind.

Sie sind reine Hilfsdokumentationen, wodurch man direkt im Skript bestimmte Informationen erhalten oder für später aufbereiten kann. Nach diesen Kommentaren kann man auch suchen lassen und bedenken Sie bei der Überlegung zu Kommentaren auch, dass ein Skript 2000 und mehr Zeilen beinhalten kann. Wenn dann mittels Bemerkungen keine Struktur gegeben ist, wird die Suche zum Halbtagsjob.

Buchtipp: PHP und MySQL für Einsteiger (Thalia)*
* = Affiliate-Link; bei Kauf unterstützen Sie diese Plattform

Lesen Sie auch

Wer den PHP-Einstieg wagt, erhält eine Welt voller Möglichkeiten für Module oder ganze Webseiten, die man im Internet ausprobieren und einsetzen kann. Das kann eine simple Seite mit PHP-Dokumente sein, meist ist es aber eine dynamische Lösung mit veränderten Navigationspunkten und aktualisierten Texten direkt aus der Datenbank.

Dazu braucht es Grundinformationen über das Programmieren mit dem Editor, über die Bedeutung der Dateierweiterungen oder wie man überhaupt zum PHP-Code kommt.

Der nächste Punkt beim Begreifen der Sprache ist die PHP-Technik. Damit ist gemeint, wie man weitere Dokumente integrieren kann, wobei include und require zur Verfügung stehen, was es mit dem ständig verwendeten echo-Befehl auf sich hat und vor allem was Variablen sind, wozu man sie braucht und wie man mit ihnen rechnen kann. Außerdem braucht es Operatoren für die späteren Schleifen.

Themenseiten

Diesen Artikel teilen

Infos zum Artikel

Kommentare im PHP-CodeArtikel-Thema: Kommentare im PHP-Code
Beschreibung: Mit ✅ Kommentare kann man den Code beim ✅ Programmieren mit PHP übersichtlich und nachvollziehbar gestalten.

Kategorien

Grundlagen
HTML-Grundlagen
CSS-Grundlagen
Javascript-Grundlagen
PHP-Grundlagen
MySQL-Grundlagen
SEO-Grundlagen

Infos, Tipps, Vermarktung
Webdesign-Lexikon
Online-Werbung
PHP-Codeschnipsel
Praxisartikel