Hugo Egon Balder: Werden php Kommentare mitverarbeitet/geparst?

Beitrag lesen

Hi dedlfix,

ich kann mich nicht erinnern, hier schon mal Ratschläge _nicht_ befolgt zu haben. Auch Du warst mir schon öfters eine große Hilfe.

In _diesem_ Fall aber muß ich trotzdem feststellen. Ich lasse mich von meinem Standpunkt nicht abbringen.

Mir ist klar, dass eine Echo-Anweisung nur eine simple Ausgabe bewirkt. Entsprechend einfach ist dann auch ein Kommentar dazu.

Du magst das unnötig finden, _mir_ ist das eine Hilfe.

Bei mir bekommt entweder jeder einzelne Befehl oder ein Programmteil einen Kommentar, in dem steht, was in Folge passiert.

Ob das Wort "Bestimmung" nun mehrdeutig ist oder nicht, interessiert mich ja in dem Zusammenhang nicht.

Sollte dich aber, denn der Leser muss es verstehen. Da hilft es ihm wenig, wenn es ihn auf eine falsche Fährte führen kann oder mehr Verwirrung stiftet als Erklärung das Ziel war.

Wie ich schon mehrfach gesagt habe, der Leser bin _ich_, da mir diese Kommentare als Hilfe beim Schreiben des Codes dienen. Und sollte ich ein Problem haben und mich mit dem Code an jemanden wenden, dann weiß der auch ganz sicher, was ich mit den Kommentaren gemeint habe bzw. was mein Ziel beim entsprechenden Programmteil war.

Eine nützliche Fähigkeit, die ich bei vielen wenig ausgeprägt finde, ist, etwas aus der Perspektive eines anderen zu betrachten.

Wie war das mit den Steinen und dem Glashaus?

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

Eben das ist der strittige Punkt. Ich sehe da nur, dass du da was hingeschrieben hast, aber deine Gedanken dazu kann ich dem nicht entnehmen.

Also komm! Um bei meinem trivialen Ursprungsbeispiel zu bleiben:

// BESTIMMUNG DES BRAUTPAARES  
// ==========================  
// 1.) Bestimmung der Namensvariablen:  
$variable1='Hans';  
$variable2='Herta';  
// 2.) Ausgabe der Namen des Brautpaares:  
echo"<p>".$variable1." und ".$variable2." sind ein Ehepaar.</p>\n";

Wenn ich Dich da um Hilfe bitten würde und Dir das so zeige, willst Du mir aber nicht sagen, dass Du durch meine Kommentare nicht verstündest, was ich damit meine und was das Ziel des entsprechenden Codeteils ist. Doppelbedeutung von technischen Ausdrücken hin oder her.

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.

Gut, dann haben wir einfach 2 unterschiedliche Auffassungen darüber. Belassen wir es dabei.

Ich bedanke mich für die Informationen und den Diskurs zu dem Thema.

MfG

Hugo Egon Balder