PHP 変数またはステートメントのコメント


プログラム内の変数またはステートメントに関するコメントは、次の原則に従います。
a.変数またはステートメントと同じ行やその後ではなく、変数またはステートメントの前の行に記述します;
b.コメントは /* */;
c の形式です。各関数の前にコメント ブロックを付ける必要があります。コンテンツには、関数関数、入出力パラメーター、期待される戻り値、およびエラー コードの定義の簡単な説明が含まれます。
d.完全な仕様に注釈を付けます。
e.コメントアウトされたコードを削除するか、コメントアウトされたコードがソースコードに残っている特別な理由を示してください。
例:

/** 
* @Purpose: 
* 数据库连接用户名 
* @Attribute/Variable Name: db_user_name 
* @Type: string 
*/ 
var db_user_name;