Werden php Kommentare mitverarbeitet/geparst?

[Timo "God's Boss" Reitz]

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.

Als Programmierer solltest du aber schon wissen, was die einzelnen Befehle tun. Was du anhand des Quelltextes nicht genau wissen kannst, ist aber der Sinn und Zweck der Befehle. Ich gebe dir mal ein passendes Beispiel in JavaScript:

Dein Kommentarstil:

function forEach(a,f,o){ // Bestimmung der Funktionsparameter  
  for(var i=0,l=a.length /* Bestimmung der Schleifenvariablen */; i<l /* Bedingung der Schleife */; i++ /* Schleifenschritt */){  
    f.call(o,a[i]);}} // Aufruf von f.call mit den Argumenten o und a[i].

Erklärender Kommentarstil:

/* Durchläuft das Array a und ruft für jedes Element a[i] die Funktion f im Kontext o mit dem Element als Argument auf. */  
function forEach(a,f,o){  
  for (var i=0,l=a.length;i<l;i++){  
    f.call(o,a[i]);}}

Wobei dieses Beispiel so trivial ist, dass es eigentlich keines Kommentars bedarf.

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

Es dauert aber viel länger, weil er die Kommentare lesen müsste, die ihm keine Hilfe sind.  
  

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

Da gibt es keine unterschiedlichen Auffassungen. `$a=$b+$c;`{:.language-php} benötigt keinen Kommentar, weil der Programmschnippsel selbsterklärend ist. Wer nicht weiß, was diese Anweisung macht, kann sowieso nicht programmieren (in PHP, in diesem Fall). Was derjenige u.U. aber nicht weiß, ist, warum `$b`{:.language-php} und `$c`{:.language-php} addiert werden und in `$a`{:.language-php} gespeichert werden.  
  

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

Wie sieht eigentlich der von dir generierte HMTL-Code aus?  
~~~html
<!-- Überschrift 1. Grades -->  
<h1>Blabla</h1>  
<!-- Absatz -->  
<p>Bla bla bla.</p>  
<!-- Ungeordnete Liste -->  
<ul>  
<!-- Listenpunkt -->  
<li>Bla bla.</li>  
(...)

?
Und CSS?

p /* Selektiert alle p-Elemente (Absätze) */  
{  
color:red; /* Färbt die Schrift rot. */  
(...)  
}

?
Wäre ja nur konsequent.