Wie und warum in Ihrem PHP-Code zu kommentieren

Ein Kommentar in PHP-Code ist eine Zeile, die nicht als Teil des Programms gelesen wird. Ihr einziger Zweck ist es, von jemandem gelesen zu werden, der den Code bearbeitet. Warum also Kommentare verwenden??

  • Anderen mitteilen, was Sie tun. Wenn Sie mit einer Gruppe von Personen zusammenarbeiten oder mit anderen Personen planen, die jemals Ihr Skript verwenden, teilen die Kommentare den anderen Programmierern mit, was Sie in den einzelnen Schritten getan haben. Dies erleichtert ihnen das Arbeiten und Bearbeiten des Codes bei Bedarf erheblich.
  • Um dich daran zu erinnern, was du getan hast. Auch wenn Sie möglicherweise nur ein schnelles Skript für sich selbst schreiben und die Notwendigkeit von Kommentaren nicht erkennen, fügen Sie sie trotzdem hinzu. Die meisten Programmierer sind ein oder zwei Jahre später zurückgekehrt, um ihre eigenen Werke zu bearbeiten, und mussten herausfinden, was sie getan haben. Kommentare können Sie an Ihre Gedanken erinnern, als Sie den Code geschrieben haben.

Es gibt verschiedene Möglichkeiten, einen Kommentar in PHP-Code einzufügen. Das erste ist mit // eine Zeile auskommentieren. Dieser einzeilige Kommentarstil kommentiert nur das Zeilenende oder den aktuellen Codeblock, je nachdem, was zuerst eintritt. Hier ist ein Beispiel:

 

 Echo "Hallo"; 

 // das ist ein Kommentar 

 Echo "dort"; 

 ?> 

Wenn Sie einen einzeiligen Kommentar haben, können Sie auch ein # -Zeichen verwenden. Hier ist ein Beispiel für diese Methode:

 

Echo "Hallo";
#dies ist ein Kommentar
Echo "dort";
?>

Wenn Sie einen längeren, mehrzeiligen Kommentar haben, können Sie ihn am besten mit / * und * / vor und nach einem längeren Kommentar kommentieren. Sie können mehrere Kommentarzeilen in einem Block enthalten. Hier ist ein Beispiel:

 

 Echo "Hallo"; 

 / * 

 Mit dieser Methode 

 Sie können einen größeren Textblock erstellen 

 und es wird alles auskommentiert 

 * / 

 Echo "dort"; 

 ?> 

Kommentare nicht mischen

Obwohl Sie Kommentare in PHP in Kommentare einbetten können, sollten Sie dies sorgfältig tun. Nicht alle nisten gleich gut. PHP unterstützt Kommentare im C-, C ++ - und Unix-Shell-Stil. Kommentare im C-Stil enden mit dem ersten * /, auf das sie stoßen. Verschachteln Sie daher keine Kommentare im C-Stil. 

Wenn Sie mit PHP und HTML arbeiten, beachten Sie, dass HTML-Kommentare für den PHP-Parser keine Bedeutung haben. Sie funktionieren nicht wie beabsichtigt und führen wahrscheinlich eine Funktion aus. Also bleiben Sie fern von: