Werden php Kommentare mitverarbeitet/geparst?

[Hugo Egon Balder]

Hi dedlfix,

// 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?

Die Kommentare dienen ja in erster Linie _mir_, und wenn es sich um Code handelt, der über mehrere Seiten in meinem Editor geht, dann ist das sehr wohl eine Hilfe, alleine schon, um den entsprechenden Punkt schneller zu finden. Mir ist gestern als Kurzbeispel nichts Besseres eingefallen, aber ich verstehe die Wortklauberei nicht. An dem Punkt in diesem (inhaltlich sinnlosen) Code "entsteht" durch die Variablen sozusagen das Brautpaar. Und wenn dies das Teilstück einer langen Seite wäre, wüßte ich beim schnellen runterscrollen auf den ersten Blick: Aha, hier werden die Namen des Brautpaares definiert. Ob das Wort "Bestimmung" nun mehrdeutig ist oder nicht, interessiert mich ja in dem Zusammenhang nicht.

// 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.

Das kann ich schon nachvollziehen, aber auch hier sehe ich es so, daß ich erstens die Stelle im Quellcode viel schneller finde (bei einer langen Seite) und zweitens bei einer Fehlermeldung wie zB Parse Error in Zeile soundso schon beim ersten Blick in den Code sehe, aha, bei der Berechnung von dem und dem ist ein Fehler drin. Natürlich ist es klar, daß eine Variablenerstellung was Simples und Eindeutiges ist und per se nicht kommentiert gehört, aber wenn ich das bei allen meinen php-Teilen so mache, dann empfinde _ich_ das einfach als eine größere Übersichtlichkeit. Tue ich das nämlich _nicht_, dann brauche ich bei einer komplexen Seite, die ich länger nicht vor mir hatte, schon sehr lange, bis ich mich zurechtfinde und sofort wieder weiß, was wofür da ist. Du darfst auch nicht vergessen, nicht jeder ist in Sachen php so gut wie zB. Du. Für mich sind Programmteile, die für Dich wahrscheinlich ohne Nachzudenken aus dem FF kommen, eine wirkliche Herausforderung. Und da _ist_ es einfach eine Hilfe, wenn ich mir alles kommentiere. Und wenn ich ein Problem habe und den Code jemanden zeige, weiß der auch sofort, was ich mir bei jedem Schritt gedacht habe und wozu der Teil jetzt gut ist oder gut sein _soll_.

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.

siehe oben

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.

[...]

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.

Darum hätte ich ja gerne ein Beispiel gesehen, gerne auch ein etwas komplexeres, um zu sehen, wie _Du_ das löst mit dem Kommentieren.

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.

Was wäre zum Beipiel "nicht offensichtlicher Sinn und Zweck"?

// 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.

siehe oben

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.

Aber es geht doch darum, daß der Empfänger dierser Ressource die Information bekommt, dass das, was hier gerade kommt, utf-8 codiert ist. Mit "Setzen" meinte ich die Tatsache, dass dies hiermit mitgeteilt wird.

Außerdem gibt es den Begriff Datei bei HTTP nicht.

Die Ressource liegt bei mir lokal als php-Dokument vor. Das _ist_ somit doch eine Datei, oder? Du hast mit all den technischen Begrifflichkeiten sicher Recht, warum ich das so formuliert habe, hab ich im letzten Absatz geschrieben.

MfG

Hugo Egon Balder