Kommentare in PHP hinzufügen: 7 Schritte (mit Bildern)

Schritte
- Teil 1 von 2: Stile
- Teil 2 von 2: Verwendung
Tipps

Kommentare innerhalb einer Programmiersprache sind bestimmte Hinweise, die verwendet werden können, um den Zweck und die Absicht eines Codeblocks zu verdeutlichen. Bei der Verwendung von PHP haben Sie mehrere Optionen zur Auswahl, die von weit verbreiteten, älteren Programmiersprachen stammen, mit zwei Möglichkeiten für einzeilige Kommentare und auch eine mehrzeilige Kommentarform, abgeleitet vom Stil des C Programmiersprache. Sie können Kommentare verwenden, um die Ausführung von Codeblöcken zu verhindern, und Sie können sie sogar verwenden, um eine Dokumentation zu erstellen.

Schritte

Teil 1 von 2: Stile

1. Verwenden Sie einen einzeiligen Kommentar für kurze Kommentare. Wenn Sie einen kurzen Kommentar posten möchten, können Sie dafür den einzeiligen Code verwenden. Dieser Kommentar geht nicht über das Zeilenende oder das Ende des Codeblocks hinaus. Diese Art von Kommentar funktioniert nur innerhalb von PHP-Tags und wird gelesen, wenn sie in HTML-Code platziert wird.

1. Verwenden Sie mehrzeilige Kommentare für ausführlichere Kommentare oder Codetests. Mehrzeilige Kommentare sind nützlich, um eine längere Erklärung zu schreiben oder die Ausführung eines bestimmten Codesegments zu verhindern. Lesen Sie den Teil "Verwendung" Unten finden Sie einige Tipps zur Verwendung von mehrzeiligen Kommentaren.

Teil 2 von 2: Verwendung

1. Verwenden Sie Kommentare, um Kommentare zur Funktionsweise des Codes zu hinterlassen. Es ist nicht notwendig, dies für jede Codezeile zu tun, da geschriebener Code für andere Programmierer leicht zu verstehen ist. Es ist nützlich, wenn der Code ungewöhnliche oder unklare Funktionen enthält.

// Curl-Anfrage generieren $session = curl_init($request); // Curl anweisen, HTTP POST zu verwenden curl_setopt ($session, CURLOPT_POST, true);

Hinterlasse einen Kommentar, damit du nicht vergisst, was du getan hast. Wenn Sie an Ihren eigenen Projekten arbeiten, können Kommentare Ihnen helfen, sich daran zu erinnern, wo Sie aufgehört haben. Kommentieren Sie Code, der nicht funktioniert oder den Sie noch nicht abgeschlossen haben.

// Muss mir das anschauen, bevor ich fortfahre echo "Hallo Welt!";

Kommentieren Sie den Code, den Sie teilen möchten. Wenn Sie eine Zusammenarbeit mit anderen planen oder den Code als Open Source veröffentlichen möchten, können Kommentare anderen helfen, herauszufinden, was Ihre Funktionen bewirken und wo sie verbessert werden können.

/* Gibt es einen effektiveren Weg, dies zu tun?? */ Geschlecht:

Verwenden Sie Kommentare, um die Ausführung bestimmter Codeblöcke zu verhindern. Dies ist nützlich, wenn Sie etwas testen und die Ausführung bestimmter Codes verhindern möchten. Alles innerhalb der Kommentar-Tags wird beim Laden der Webseite ignoriert.

2. Seien Sie vorsichtig, wenn Sie große Codeblöcke kommentieren. Die Kommentarfunktion wird beendet, wenn das erste End-Tag signalisiert wird. Wenn es also bereits einen mehrzeiligen Kommentar im Code gibt, den Sie kommentieren möchten, wird dieser Kommentar am Ende des verschachtelten Kommentars beendet.

3. Verwenden Sie Kommentare, um Pseudodokumentationen zu erstellen. Sie können einige kreative Formatierungen verwenden, um eine Dokumentation für Ihren Code direkt im Code zu erstellen. Dies kann für Open-Source-Projekte nützlich sein.

Tipps

HTML-Kommentare und PHP-Kommentare sind unterschiedlich. Wenn Sie also Skripte (eine Mischung aus HTML und PHP) verwenden, achten Sie darauf, die Kommentarcodes nicht zu verwechseln.
Der folgende Code enthält beispielsweise HTML-Kommentare, aber PHP-Code wird trotzdem ausgeführt. Das Platzieren von HTML-Kommentaren in PHP-Tags führt zu Fehlern.