PHP變數或語句註釋
程式中變數或語句的註解遵循以下原則:
a.寫在變數或語句的前面一行,而不寫在同儕或後面;
b.註釋採用/* */的方式;
c.每個函數前面要包含一個註解塊。內容包含函數功能簡述,輸入/輸出參數,預期的回傳值,出錯程式碼定義。
d.註釋完整規範。
e.把已經註解掉的程式碼刪除,或是註明這些已經註解掉的程式碼仍然保留在原始碼中的特殊原因。
範例:
/** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name;