Inhalt
Ein Kommentar ist eine Art Notiz, die verwendet werden kann, um den Zweck und die Bedeutung eines Code-Snippets zu erklären. Wenn Sie in PHP arbeiten, haben Sie mehrere Möglichkeiten, Kommentare zu schreiben, die aus den alten bekannten Programmiersprachen stammen: durch die Eingabe von einzeiligen oder mehrzeiligen C-Kommentaren. Sie können Kommentare verwenden, um zu verhindern, dass ein Teil des Codes funktioniert, oder um einfach Aufzeichnungen zu führen.
Schritte
Teil 1 von 2: Stile
1 Einzeilige Kommentare für kurze Beiträge. Wenn Sie einen kurzen Kommentar hinterlassen müssen, verwenden Sie den einzeiligen Kommentarcode. Der Kommentar reicht nur bis zum Ende einer Zeile oder bis zum Ende eines Codeblocks. Solche Kommentare funktionieren nur innerhalb von PHP-Tags und werden nur gelesen, wenn sie in HTML platziert werden. ?php // Dies ist die Standardmethode (C++), um einen einzeiligen Kommentar zu erstellen # Sie können diesen Unix-Stil auch verwenden, um einen einzeiligen Kommentar zu erstellen?> var13 ->
2 Verwenden Sie mehrzeilige Kommentare, um lange Kommentare zu schreiben oder Code zu testen. Mehrzeilige Kommentare sind sehr nützlich, um lange Erklärungen zu schreiben und zu verhindern, dass ein Codeabschnitt verarbeitet wird. Lesen Sie den Abschnitt Verwendung für einige Tipps zur Verwendung von mehrzeiligen Kommentaren. ?php / * So formatieren Sie einen mehrzeiligen Kommentar. Der gesamte Text bis zum Ende des Tags wird in den Kommentar aufgenommen * / / * Manche Leute fügen * am Anfang jeder Zeile * zusätzliche Aufzählungszeichen ein. Dies verbessert die Lesbarkeit von großen Kommentaren, obwohl dies nicht erforderlich ist. * /?> var13 ->
Teil 2 von 2: Verwenden von
1 Verwenden Sie Kommentare, um Notizen zur Codeintegrität zu hinterlassen. Sie müssen dies nicht für jede Codezeile tun, da andere Programmierer gut geschriebenen Code leicht herausfinden können. Kommentare sind nützlich, wenn Ihr Code nicht standardmäßige oder nicht offensichtliche Funktionen ausführt. // Erstelle eine curl-Anfrage $ session = curl_init ($ request); // Curl anweisen, HTTP POST zu verwenden curl_setopt ($ session, CURLOPT_POST, true);
2 Hinterlassen Sie Kommentare, damit Sie nicht vergessen, was Sie mit dem Code gemacht haben. Wenn Sie an einem Projekt arbeiten, verhindern Kommentare, dass Sie vergessen, wo Sie aufgehört haben. Hinterlassen Sie Kommentare für Code, der nicht richtig funktioniert oder noch nicht fertig ist. // Bevor Sie mit dem nächsten Schritt fortfahren, überprüfen Sie die Ausgabe dieses Programms noch einmal echo "Hello World!";
3 Hinterlassen Sie einen Kommentar für den Code, den Sie teilen möchten. Wenn Sie planen, mit anderen Programmierern zusammenzuarbeiten oder Ihren Code öffentlich zugänglich zu machen, helfen Kommentare anderen, zu verstehen, wie Ihr Code funktioniert und was behoben werden muss. / * Gibt es einen besseren Weg, dies zu erreichen? * / Gender: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "checked" ; ?> value = "weiblich"> weiblich input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "checked";?> value = "male " > Männlich
4 Hinterlassen Sie Kommentare, um bestimmte Codeblöcke rückgängig zu machen. Dies ist sehr nützlich, wenn Sie Ihren Code testen und die Ausführung eines Teils davon stoppen möchten. Alles, was im Kommentarzeichen enthalten ist, wird beim Starten der Seite ignoriert. ?php echo "/ * Hallo * / Welt!"; / * Wenn der obige Code ausgeführt wird, wird das Wort "Hello" nicht angezeigt * /?> Var13 ->
5 Seien Sie vorsichtig, wenn Sie große Codeblöcke auskommentieren. Die Kommentarfunktion wird beendet, wenn das erste Abschlusszeichen aktiv ist. Wenn sich also ein mehrzeiliger Kommentar im Code befindet, den Sie bereits kommentiert haben, dauert dieser nur bis zum Anfang des ursprünglichen Kommentars. ?php / * echo "Hallo Welt!"; / * Dieser Kommentar wird alles ruinieren * / * /?> Var13 ->
?php / * echo "Hallo Welt!"; // Dieser Kommentar ist in Ordnung * /?> Var13 ->
6 Verwenden Sie Kommentare, um Pseudoaufnahmen zu erstellen. Sie können einige Creative-Codeformate verwenden, um direkt darin einen Codeeintrag zu erstellen. Dies ist sehr nützlich für Open-Source-Projekte. ?php // ============= // HEADER // ============== // ------------ - // Untertitel // ------------- / * Abschnittsname * / # Hier können Einträge geschrieben werden # Der zweite Teil kann hier geschrieben werden / * * Verwenden Sie dies zur Erklärung * warum brauchst du ein paar Zeilen * oder sogar ein paar Erklärungspunkte * /?> var13 ->
Tipps
- HTML- und PHP-Kommentare unterscheiden sich voneinander. Stellen Sie daher bei der Arbeit mit Skripten (einer Kombination aus HTML und PHP) sicher, dass Sie die richtige Syntax verwenden.
- Der folgende Code enthält beispielsweise einen HTML-Kommentar, führt aber dennoch den PHP-Code aus. Wenn Sie einen HTML-Kommentar in ein PHP-Tag einfügen, führt dies zu einem Fehler.
- ! - div id = "Beispiel">?php echo ’hallo’; ?> var13 -> / div> ->
