Kommentare zu PHP-Variablen oder -Anweisungen
Die Kommentare von Variablen oder Anweisungen im Programm folgen den folgenden Prinzipien:
a. Schreiben Sie es in die Zeile vor der Variablen oder Anweisung, nicht in dieselbe Zeile oder danach
b. Kommentare haben das Format /* */;
c. Jeder Funktion muss ein Kommentarblock vorangestellt sein. Der Inhalt umfasst eine kurze Beschreibung der Funktionsfunktionen, Eingabe-/Ausgabeparameter, erwarteten Rückgabewerte und Fehlercodedefinitionen.
d. Kommentieren Sie die vollständige Spezifikation.
z.B. Löschen Sie den auskommentierten Code oder geben Sie den besonderen Grund an, warum der auskommentierte Code weiterhin im Quellcode verbleibt.
Beispiel:
/** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name;