Kommentare in PHP während der Skriptausführung werden vom Präprozessor ignoriert und nur für Personen benötigt. Entwickler vernachlässigen oft das Kommentieren von Code.

Die Programmierer sind der Meinung, dass sie sich nach sechs Monaten und einem Jahr daran erinnern werden, wie der Code funktioniert. Ein weiterer Grund, keine Kommentare zu hinterlassen, ist der Glaube, dass der Code so gut geschrieben ist, dass er klar und ohne Erklärung ist. Beachten Sie jedoch, dass es möglicherweise erforderlich sein kann, die erstellten PHP-Skripte nach dem Schreiben noch lange zu warten.

Ein ebenso wichtiger Grund für das Kommentieren von Code besteht darin, sicherzustellen, dass Follower Ihre Erstellung unterstützen oder Funktionen hinzufügen. Sie werden auch vom Lesen der Kommentare profitieren.

PHP bietet zwei Möglichkeiten zum Kommentieren: eine für einzeilige Kommentare und die zweite für mehrzeilige Kommentare. PHP übernimmt die Syntax von Kommentaren aus C, C ++ und Java. Wenn Sie mit ihnen vertraut sind, gibt es keine Überraschungen für Sie.

PHP Single Line Comments

Vor Kommentaren, die sich in derselben Zeile befinden, werden in PHP zwei Schrägstriche (//) gesetzt.

Das folgende Beispiel enthält einen einzeiligen PHP-Kommentar im Code:

Ein einzeiliger Kommentar kann in einer separaten Zeile oder am Ende einer Codezeile eingefügt werden:

Im obigen Beispiel führt der PHP-Präprozessor die Echo-Funktion aus und ignoriert alles nach //.

Einzeilige Kommentare werden auch verwendet, um Codezeilen vorübergehend aus einem Ausführungsthread zu entfernen. Die folgende Änderung gegenüber dem vorherigen Beispiel führt beispielsweise dazu, dass PHP den gesamten Echo-Befehl zur Laufzeit ignoriert:

PHP mehrzeilige Kommentare

Mehrzeilige Kommentare für die PHP-Site werden mit den Trennzeichen / * und * / umbrochen. Das Symbol / * kennzeichnet den Anfang eines Kommentarblocks und * / dessen Ende. Das folgende Beispiel zeigt die Verwendung von mehrzeiligen Kommentaren:

Mehrzeilige Kommentare sind nützlich, wenn Notizen, die Sie in Code einfügen möchten, mehr als eine Zeile umfassen. Die Möglichkeit, Zeilenblöcke als Kommentare zu markieren, vermeidet die Verwendung eines einzelnen Zeilenkommentars am Anfang jeder Zeile.

Eine weitere nützliche Verwendung von mehrzeiligen Kommentaren besteht darin, PHP-Codeblöcke vorübergehend zu deaktivieren. In der Regel schreiben Sie ein PHP-Skript und überlegen, ob Sie es neu schreiben können, damit es effizienter wird. In dieser Situation können Sie den alten Code auskommentieren, sodass er nicht mehr ausgeführt wird, und einen neuen schreiben. Wenn sich herausstellt, dass der neue Code schlechter ist als der ursprüngliche, können Sie Kommentare und neuen Code in PHP löschen. Und dann entfernen Sie das alte Kommentar, um es an den Thread der Ausführung zurückzugeben.

Sowohl einzeilige als auch mehrzeilige Kommentare können mit einer speziellen Syntax problemlos zum PHP-Code hinzugefügt werden. Versuchen Sie, die Gewohnheit zu entwickeln, Ihren Code zu kommentieren.

Nachdem wir einige grundlegende PHP-Konzepte kennengelernt haben, ist es an der Zeit, die Grundlagen dieser Programmiersprache zu erlernen und mit der Einführung von PHP-Variablen zu beginnen.

Diese Publikation ist eine Übersetzung des Artikels “Commenting PHP Code”, der vom freundlichen Team des Internet technology.ru-Projekts erstellt wurde

Kommentar PHP-Syntax: einzeiliger Kommentar

Während es in HTML nur eine Art von Kommentar gibt, gibt es in PHP bis zu zwei Arten. Der erste Typ, den wir diskutieren werden, ist ein einzeiliger Kommentar. Dies ist ein Kommentar, der den Interpreter auffordert, alle Vorgänge in dieser Zeile rechts neben den Kommentaren zu ignorieren. Verwenden Sie zur Verwendung dieses Kommentars die Zeichen "//" oder "#". Der gesamte Text auf der rechten Seite wird vom PHP-Interpreter ignoriert.

Bitte beachten Sie, dass einige unserer Echo-Befehle nicht verarbeitet wurden, da wir sie mit speziellen Kommentarzeichen auskommentiert haben. Diese Art von Kommentar wird häufig verwendet, um komplexen und verwirrenden Code schnell aufzuschreiben oder eine Zeile PHP-Code vorübergehend zu entfernen (zum Debuggen).

Kommentar PHP-Syntax: mehrzeiliger Kommentar

Wie HTML-Kommentare können auch mehrzeilige Kommentare in PHP verwendet werden, um große Codeblöcke auszukommentieren oder Kommentare in mehrere Zeilen zu schreiben. Mehrzeilige Kommentare in PHP beginnen mit "/ *" und enden mit "* /". Alles zwischen diesen Zeichen wird ignoriert.

Das Auskommentieren des Codes ist gut!

Das Kommentieren kann ich allen unerfahrenen PHP-Programmierern empfehlen. Kommentiere deinen Code! So viele Leute schreiben komplexen Code in PHP und sind entweder zu faul, um gute Kommentare zu schreiben, oder denken, dass Kommentare nicht benötigt werden. Glauben Sie jedoch wirklich, dass Sie sich genau daran erinnern können, was Sie dachten, als Sie diesen Code vor einem Jahr oder länger geschrieben haben?

Schreiben Sie noch heute Kommentare und Sie werden sich in Zukunft dafür bedanken! :) Es wird nicht schwierig sein, zwei Schrägstriche zu machen und ein paar Worte über den Code zu schreiben, aber es wird sehr nützlich sein, wenn Sie nach einer Weile wieder darauf zurückkommen!

Anmerkungen:

  1. Mischa - 03/04/2013 12:47

Ja, das Kommentieren des Codes ist sehr wichtig, da stimme ich dem Autor absolut zu!

Sergey - 25.03.2013 21:46 Uhr

Ich habe alles verstanden, wie es geht, aber selbst der Text in der Datei index.pxp wird für mich nicht angezeigt, nichts weiter, im selben Ordner der Text in der Datei menu.pxp

Sergey, ich habe ehrlich gesagt nichts verstanden) Was wird nicht angezeigt und wo? Kommentare sollten nicht angezeigt werden - sie sind nur im Quellcode der Seite sichtbar.

Stas - 28.02.2017, 13:55 Uhr

Noch einfacher ist es, ein Skript mit vorgefertigten Kommentaren auf einer Site wie disqus zu platzieren

Vitaly - 23.05.2017 13:30 Uhr

Stas, schreist du)) woher kommt der Diskus? Es geht nicht darum, die Site zu kommentieren, sondern darum, Teile, Blöcke oder Codezeilen in PHP zu kommentieren - damit Sie später besser verstehen, was Sie geschrieben haben, und wenn jemand anderen den Code liest, wird es auch einfacher sein))