ThinkPHP API框架代碼規范指南

ThinkPHP是一個基于PHP的輕量級Web開發框架，它遵循MVC（模型-視圖-控制器）設計模式。為了保持代碼的可讀性、可維護性和可擴展性，遵循一定的代碼規范是非常重要的。以下是一些ThinkPHP API框架的代碼規范指南：

1. 目錄結構

project/
├── application/
│   ├── controller/
│   ├── model/
│   ├── view/
│   ├── public/
│   │   ├── css/
│   │   ├── js/
│   │   ├── img/
│   ├── runtime/
│   ├── config.php
│   ├── routes.php
├── vendor/
├── composer.json
├── phpunit.xml
├── README.md

2. 命名規范

• 類名：使用大駝峰命名法（PascalCase），例如UserController。
• 方法名：使用小駝峰命名法（camelCase），例如getUserInfo。
• 變量名：使用小駝峰命名法（camelCase），例如$userName。
• 常量名：使用全大寫字母和下劃線分隔，例如API_SUCCESS。

3. 文件和目錄命名

• 目錄和文件名使用小寫字母，單詞之間使用連字符（-）分隔。
• 避免使用特殊字符和空格。

4. 注釋規范

• 單行注釋：使用//，例如// 獲取用戶信息。
• 多行注釋：使用/* */，例如：

  /*
  * 獲取用戶信息
  */
  

• 文檔注釋：使用DocBlock格式，例如：

  /**
   * 獲取用戶信息
   * @param int $userId 用戶ID
   * @return array 用戶信息
   */
  

5. 代碼風格

• 使用4個空格進行縮進。
• 每行代碼長度不超過80個字符。
• 遵循PEP 8編碼規范。

6. 控制器（Controller）

• 控制器文件名格式：{ControllerName}Controller.php。
• 控制器類名格式：{ControllerName}Controller。
• 控制器方法名格式：action{ActionName}。

7. 模型（Model）

• 模型文件名格式：{ModelName}Model.php。
• 模型類名格式：{ModelName}Model。

8. 視圖（View）

• 視圖文件名格式：{ControllerName}/{ActionName}.html。
• 視圖文件應包含邏輯處理部分，例如：

  {extend name="base" /}
  {block name="title" /}
  <h1>{$title}</h1>
  {/block}
  

9. 公共文件（Public）

• CSS、JS、圖片等資源文件應放在public目錄下。

10. 配置文件（Config）

• 配置文件應放在application/config.php中。

11. 路由文件（Routes）

• 路由文件應放在application/routes.php中。

12. 測試文件（PHPUnit）

• 測試文件應放在tests目錄下，文件名格式：{TestClassName}Test.php。

13. Composer依賴管理

• 使用Composer管理項目依賴，確保composer.json文件中列出了所有必要的依賴包。

14. 單元測試

• 編寫單元測試用例，確保代碼的正確性和穩定性。

15. 文檔

• 編寫項目文檔，包括安裝指南、使用說明和API文檔。

通過遵循這些代碼規范，可以確保ThinkPHP API框架的代碼結構清晰、易于維護和擴展。