Schreiben effektiver PHP -Kommentare

Kommentare können nicht nachlässig sein, da sie die Gründe für die Existenz des Codes und nicht die Funktionen erklären möchten, z. B. die Kompatibilität mit alten Schnittstellen oder Einschränkungen von Drittanbietern, sonst können Personen, die den Code lesen, nur auf Vermutungen angewiesen. Die Bereiche, die kommentiert werden müssen, umfassen komplexe bedingte Urteile, spezielle Fehlerbehandlungslogik und vorübergehende Bypass -Beschränkungen. Eine praktischere Möglichkeit, Kommentare zu schreiben, besteht darin, Einzelzeilen-Kommentare auszuwählen oder Kommentare basierend auf der Szene zu blockieren. Verwenden Sie Dokumentblock Kommentare, um Parameter zu erläutern und Werte zu Beginn von Funktionen, Klassen und Dateien zurückzugeben, und halten Sie die Kommentare aktualisiert. Für eine komplexe Logik können Sie dem vorherigen eine Zeile hinzufügen, um die Gesamtabsicht zusammenzufassen. Verwenden Sie gleichzeitig keine Kommentare zum Versiegelungscode, sondern verwenden Sie Versionsteuerungswerkzeuge.

Das Schreiben von PHP -Kommentaren ist eigentlich sehr wichtig, aber viele Menschen tun es nicht richtig. Kommentare werden nicht nur nur ein paar Sätze geschrieben. Der Schlüssel ist, anderen (oder in Zukunft in Zukunft) den Code schneller zu verstehen.

Warum können Kommentare nicht schlampig sein?

Wenn viele Anfänger Kommentare schreiben, schreiben sie gerne mehrdeutige Inhalte wie "Diese Funktion macht etwas", was tatsächlich gleichwertig ist, ihn nicht zu schreiben. Ein guter Kommentar sollte erklären, warum dieser Code existiert und nicht das, was er tut . Zum Beispiel:

• Diese Logik dient zur Kompatibilität mit alten Versionen von Schnittstellen
• Ein bestimmter Parameter muss speziell aufgrund der Einschränkungen von Bibliotheken von Drittanbietern behandelt werden

Wenn diese Informationen nicht ausgeschrieben sind, können Personen, die den Code lesen, nur erraten.

Wo muss ich Kommentare hinzufügen?

Einige Codeblöcke werden empfohlen, um Kommentare hinzuzufügen, auch wenn sie sehr klar aussehen, z. B.:

• Komplexes bedingendes Urteil, insbesondere wenn es um mehrschichtige Multischichten nistet, wenn
• Spezielle Fehlerbehandlungslogik
• Grenzen, die vorübergehend umgangen werden müssen (z. B. wird ein Patch angewendet)

Wenn Sie beispielsweise über einen Code verfügen, der die Zeitformatkonvertierung verarbeitet, wissen Sie, dass er nur den Code betrachtet, dass er Formate konvertiert, aber nicht wissen, warum Sie strtotime() anstelle von direktem DateTime -Objekt verwenden müssen. Zu diesem Zeitpunkt kann ein Kommentar viele Zweifel sparen.

Wie schreibe ich Kommentare praktischer?

Es gibt zwei häufig verwendete Annotationsmethoden in PHP: Einzellinienkommentar // und Block Kommentar /* */ . Empfohlene Auswahl basierend auf der Szene:

• Verwenden Sie eine kurze Beschreibung //
• Funktionen, Klassen und Dateien werden zu Beginn mit Dokumentblöcken kommentiert, wie z. B.:

 /**
 * Verarbeiten Sie die Benutzeranmeldungslogik, einschließlich Überprüfungsprozess von Drittanbietern**
 * @param String $ username username * @param String $ Passwort Passwort * @return bool login ist erfolgreich */

Einige andere Tipps:

• Verwenden Sie keine Kommentare zum "Versiegel" große Codestücke. Verwenden Sie stattdessen Versionskontrollwerkzeuge
• Bleiben Sie die Kommentare auf dem neuesten Stand und lassen Sie die alten Kommentare nicht irreführen
• Wenn die Logik kompliziert ist, können Sie eine Zeile von Kommentaren hinzufügen, um die Gesamtabsicht zusammenzufassen

Letzter Punkt: Haben Sie keine Angst davor, ein paar weitere Sätze zu schreiben

Manchmal werden Sie denken: "Ist dieser Code nicht offensichtlich?" Aber wenn Sie in ein paar Monaten zurückkommen, um es zu sehen, müssen Sie möglicherweise lange darüber nachdenken. Anstatt es danach zu bereuen, ist es besser, noch ein paar Sekunden damit zu verbringen, es herauszuschreiben. Besonders für einige "Grubenpunkte" oder "nicht standardmäßige Praktiken", selbst wenn Sie ein oder zwei weitere Sätze schreiben, ist es für spätere Generationen sehr hilfreich.

Grundsätzlich ist das alles. Kommentare scheinen klein zu sein, aber es ist wirklich eine Verschwendung von Dingen, wenn Sie es nicht gut machen können.

Das obige ist der detaillierte Inhalt vonSchreiben effektiver PHP -Kommentare. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!