Commentaires sur une variable ou une instruction PHP
Les commentaires des variables ou des instructions du programme suivent les principes suivants :
a. Écrivez-le sur la ligne avant la variable ou l'instruction, pas sur la même ligne ou après
b. Les commentaires sont au format /* */; Chaque fonction doit être précédée d'un bloc de commentaire. Le contenu comprend une brève description des fonctions, des paramètres d'entrée/sortie, des valeurs de retour attendues et des définitions de codes d'erreur.
d. Annotez la spécification complète.
e. Supprimez le code commenté ou indiquez la raison particulière pour laquelle le code commenté reste toujours dans le code source.
Exemple :
/** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name;