SELFPHP

SELFPHP-Druckversion
Original Adresse dieser Seite:
http://www.selfphp.de/praxisbuch/praxisbuchseite.php?site=83&group=20
© 2001-2017 E-Mail SELFPHP OHG, info@selfphp.de
© 2005-2017 E-Mail PHP5 Praxisbuch - Matthias Kannengiesser, m.kannengiesser@selfphp.de


Kommentare


Wer kennt die Situation nicht: Man hat eine längere Berechnung durchgeführt, einen Artikel verfasst oder eine Skizze erarbeitet und muss diese Arbeit nun anderen Personen erklären. Leider ist die Berechnung, der Artikel oder die Skizze schon ein paar Tage alt und man erinnert sich nicht mehr an jedes Detail oder jeden logischen Schritt. Wie soll man seine Arbeit auf die Schnelle nachvollziehen?

In wichtigen Fällen hat man deshalb bereits beim Erstellen dafür gesorgt, dass jemand anders (oder man selbst) diese Arbeit auch später noch verstehen kann. Hierzu werden Randnotizen, Fußnoten und erläuternde Diagramme verwendet – zusätzliche Kommentare also, die jedoch nicht Bestandteil des eigentlichen Papiers sind.

Auch Ihre Programme werden mit der Zeit immer größer werden. Sie benötigen deshalb eine Möglichkeit, Ihren Text mit erläuternden Kommentaren zu versehen. Da sich Textmarker auf dem Monitor schlecht machen, besitzt die Sprache ihre eigenen Möglichkeiten, mit Kommentaren umzugehen.

Jedes Programm, auch das kleinste, sollte sauber kommentiert werden. Eine ordentliche Dokumentation erleichtert die Arbeit während der Entwicklung erheblich. Kommentare sind ein wesentlicher Bestandteil der Dokumentation. Stil und Inhalt sollten dem Programmierer die Übersicht in seinem Code garantieren, aber auch anderen, die mit dem Programm zu tun haben, etwa den Teamkollegen bei Projektarbeiten. Denken Sie daran, dass Ihre Überlegungen bei der Umsetzung eines Problems nicht immer ohne Weiteres nachvollziehbar sind. Oft gibt es sehr viele Lösungen für eine Idee, die umgesetzt werden soll. Warum Sie eine bestimmte Lösung gewählt haben und wie diese anzuwenden ist, wird in Kommentaren beschrieben.

Kommentare im PHP-Code werden nicht mit übertragen. Der Interpreter ignoriert diese Zeilen und entfernt sie vor der Übertragung. PHP unterstützt Kommentare sowohl nach Art von C/C++ als auch nach Art Java/JavaScript. Dabei ist zwischen einzeiligen und mehrzeiligen Kommentaren zu unterscheiden. Ich werde Ihnen nun die unterstützen Kommentare vorstellen.

Im folgenden Kommentar wird festgehalten, wer die Autoren sind.

Einzeiliger Kommentar:
// Autor: Matthias Kannengiesser
// Autorin: Caroline Kannengiesser

Einzeiliger Kommentar am Zeilenende:

$name = "Caroline"; // Dies ist ein Kommentar am Zeilenende

Mehrzeiliger Kommentar:
/*
-- Anfang Beschreibung --
...
-- Ende Beschreibung --
*/

Tipp: Ein Kommentar kann auch dazu verwendet werden, einen Codeabschnitt zeitweilig, ohne direkt ältere Codezeilen zu löschen, zu deaktivieren. So etwas bezeichnet man in der Programmierung als auskommentieren. Ein Vorteil beim Auskommentieren von Code liegt darin, diesen zu einem späteren Zeitpunkt ohne größeren Aufwand wiederherzustellen bzw. aktivieren zu können, indem die Kommentarzeichen entfernt werden.

Für den letzten Fall gibt es noch eine weitere Variante. Mit dem Zeichen # können ebenfalls Kommentare gekennzeichnet werden:

$vorname = "Matthias"; # Name des Autors

Hier ein Beispiel, in dem alle drei Kommentararten vorkommen:

<?php
/*

Hier ein mehrzeiliger Kommentar
im PHP-Code

*/

$vorname = "Matthias"; # Vorname des Autors
$nachname = "Kannengiesser"; // Nachname des Autors

echo $vorname /* Ausgabe */
?>

Sie sehen, was letztlich zum Einsatz kommt, bleibt ganz Ihnen überlassen.