PHP註釋規範

PHP註釋規範

註釋在寫代碼的過程中非常重要，好的註釋能讓你的代碼讀起來更輕鬆，在寫代碼的時候一定要注意註釋的規範。

---

php裏面常見的幾種註釋方式：

1.文件的註釋，介紹文件名，功能以及作者版本號等信息

/**
 * 文件名簡單介紹
 * 
 * 文件功能
 * @author  作者
 * @version  版本號
 * @date  2020-02-02
 */

2.類的註釋，類名及介紹

/**
 * 類的介紹
 * 
 * 類的詳細介紹（可選）
 * @author  作者
 * @version  版本號
 * @date  2020-02-02
 */

3.函數的註釋，函數的作用，參數介紹以及返回類型

/**
 * 函數的含義說明
 * 
 * @access  public 
 * @author  作者
 * @param mixed $arg1  參數一的說明 
 * @param mixed $arg2  參數二的說明
 * @return array  返回類型
 * @date  2020-02-02
 */

---

PHP命名規範

1.目錄和文件

• 目錄使用小寫+下劃線
• 類庫，函數文件統一以.php爲後綴
• 類的文件名均以命名空間定義，並且命名空間的路徑和類庫文件所在路徑一致
• 類文件採用駝峯法命名（首字母大寫），其他文件採用小寫+下劃線命名
• 類名和類文件名保持一致，統一採用駝峯法（首字母大寫）

2.函數和類，屬性命名

• 類的命名採用駝峯法（首字母大寫），例如 User、UserType，默認不需要添加後綴，例如UserController應該直接命名爲User
• 函數的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如 get_client_ip
• 方法的命名使用駝峯法（首字母小寫），例如 getUserName(如果方法有返回值，那麼目前習慣上將首字母用小寫的屬性類型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等)
• 屬性的命名使用駝峯法（首字母小寫），例如 tableName、instance（目前習慣上將首字母用小寫的屬性類型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等）
• 以雙下劃線“__”打頭的函數或方法作爲魔法方法，例如 __call 和 __autoload

3.常量和配置

• 常量以大寫字母和下劃線命名，例如 APP_PATH和 THINK_PATH
• 配置參數以小寫字母和下劃線命名，例如 url_route_on 和url_convert

4.數據表盒字段

• 數據表和字段採用小寫加下劃線方式命名，並注意字段名不要以下劃線開頭，例如 think_user 表和 user_name字段，不建議使用駝峯和中文作爲數據表字段命名

 

轉載地址：https://blog.csdn.net/whucaodi/article/details/59104297