nicht angemeldet
echo $begrüßung;
Hi dedlfix,
Vielleicht nur ein Formulierungsfehler, aber hinzuschreiben was passiert, ist überflüssig. Das sieht man aus dem Code. Es ist sinnvoller, hinzuschreiben, was passieren _soll_
ich verstehe den Unterschied nicht, den Du meinst.
Das große Ganze ergibt sich aus der Summe der Einzelteile. Nicht nur die kleinen Aufgaben sondern auch die Erläuterung des eigentlichen Zieles ist sinnvoll. Denn irgendwie müssen ja die Teile auch zusammenspielen, um das Ziel zu erreichen.
Laß uns das mal an Hand eines _völlig_ trivialen php-Beispiels ansehen. Das würde bei mir _so_ aussehen:
// Setzen der utf-8 Kodierung für diese Datei:
header("Content-type:text/html;charset=utf-8");
Das ist eigentlich trivial und braucht keinen Kommentar. Außerdem ist er nicht richtig. Diese Angabe teilt dem Empfänger mit, welcher MIME-Type und welche Kodierung vorliegt. Sie wird damit keineswegs beeinflusst, wie man den Kommentar deuten kann. Außerdem gibt es den Begriff Datei bei HTTP nicht. Es ist ein Dokument oder Ressource. Schließlich wird der auszuliefernde Inhalt erst erzeugt und ob der Client daraus eine Datei macht ist ungewiss und unerheblich.
Inhaltlich würde ich es so formulieren: Informieren des Empfängers über die Art der Daten mittels eines HTTP-Headers.
// BESTIMMUNG DES BRAUTPAARES
Bestimmung ist mehrdeutig interpretierbar, was bedeutet es in diesem Fall konkret? Sinn und Zweck des Brautpaares oder Ermittlung von Daten über es?
// 1.) Bestimmung der Namensvariablen:
$variable1='Hans';
$variable2='Herta';
Variablen zu erstellen ist etwas, das man beim Programmieren gleich zu Anfang kennenlernt, also kein kommentierungswürdiger Vorgang an sich. Interessant wäre(n) die Aufgabe(n) der Variable(n), besonders bei solch einem unpassenden Variablennamen. Auch hier ist wieder "Bestimmung" ein ungünstiges Wort, denn es wird ja nichts ermittelt sondern nur aus festen Werten initialisiert. Vielleicht wird im eigentlichen Code der Inhalt von woanders hergeholt, dann wäre es vielleicht interessant über diesen Vorgang etwas zu erfahren, wenn das nicht zum Programmiergrundwissen gehört.
// 2.) Ausgabe der Namen des Brautpaares:
echo"<p>".$variable1." und ".$variable2." sind ein Ehepaar.</p>\n";
echos alleinige Aufgabe ist nun mal die Ausgabe. Ein Kommentar in der Richtung ist überflüssig. abgesehen davon, dass die Variablen keine aussagekräftigen Namen haben. Ein Kommentar lohnt sich dann, wenn etwas nicht offensichtliches erfolgt. Beispielsweise vielleicht, wenn ein auszugebender (Teil)ausdruck eine Berechnung ist, dann wäre der Sinn der Berechnung interessant, so er sich nicht von selbst erklärt.
// BESTIMMUNG DES JUBILÄUMS
// ========================
// 1.) Bestimmung der Jahreszahlen:
$hochzeitsjahr='1965';
$aktuellesjahr='2008';
Siehe oben.
// 2.) Berechnung des Jubiläums:
$ehedauer=$aktuellesjahr-$hochzeitsjahr;
Hier sieht man ebenfalls auf den ersten Blick, dass es sich um eine Berechnung handelt. Zudem ist schon durch die Wahl der Variablennamen der Sinn dieser Zeile gut zu erkennen.
// 3.) Ausgabe des Hochzeitjubiläums:
echo" <p>Die beiden feiern heuer ihr ".$ehedauer.". Ehejahr.</p>\n";
Ebenfalls siehe oben.
Also abgesehen von der Sinnlosigkeit und Einfachheit dieser Seite, es geht hier jetzt nur um die prinzipielle Frage der Kommentierung: Wie würdest Du das anhand Deiner Kommentar-Kriterien lösen?
Dieses Beispiel ist eben aufgrund seiner Einfachheit wenig geeignet, eine meiner Meinung nach gute Kommentierung zu zeigen. Stattdessen konnte ich nur die vorhandene kritisieren. Ich hoffe aber, dass trotzdem deutlich wurde, welche Art der Kommentierung ich bevorzuge: eine die nicht offensichtlichen Sinn und Zweck beschreibt sowie Hintergrundwissen zu einem bestimmten Vorgang vermittelt.
echo "$verabschiedung $name";
Der Martin