PHP development coding standards
/ PHP變量或者語句注釋
PHP變量或者語句注釋
PHP變量或者語句注釋
程序中變量或者語句的注釋遵循以下原則：
a． 寫在變量或者語句的前面一行，而不寫在同行或者后面；
b． 注釋采用/* */的方式；
c． 每個(gè)函數(shù)前面要包含一個(gè)注釋塊。內(nèi)容包括函數(shù)功能簡(jiǎn)述，輸入/輸出參數(shù)，預(yù)期的返回值，出錯(cuò)代碼定義。
d． 注釋完整規(guī)范。
e． 把已經(jīng)注釋掉的代碼刪除，或者注明這些已經(jīng)注釋掉的代碼仍然保留在源碼中的特殊原因。
例子：
/** * @Purpose: * 數(shù)據(jù)庫連接用戶名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name;