盗墓笔记有声小说,辰东,盗墓笔记小说全集

云業(yè)務(wù)管理系統(tǒng)（國內(nèi)版）

開發(fā)規(guī)范

最后更新時間：2021-09-17 17:10:06

## 目錄規(guī)范

-  **app/Plugin 插件目錄（每個子目錄代表一個插件）**

-  **app 應(yīng)用模塊目錄**

- Admin 后臺模塊
  - Common 公共模塊，不能通過URL訪問
  - Home 前臺模塊
  - User 用戶中心模塊

- **libs 類庫目錄**

- Niaoyun 業(yè)務(wù)類庫

- **template 模板目錄**

- Admin 后臺模塊資源文件目錄
  - Home 前臺模塊資源文件目錄
  - User 用戶中心資源文件目錄
  - Common 公共靜態(tài)資源文件

- **Uploads 公共上傳根目錄**

## 編碼規(guī)范

- **功能沒有完成的時候一定要寫 (TODO:)**

- **方法和函數(shù)有注釋，注釋內(nèi)容包括功用，參數(shù)，返回值，作者，必要時還有示例**

- **邏輯復(fù)雜的代碼，關(guān)鍵部分應(yīng)有注釋**

#### PHP編碼規(guī)范

- **類文件命名- 同ThinkPHP命名規(guī)范**

- 公共控制器的名稱應(yīng)該和模塊名稱相同
  - 默認控制器層 Controller

- **方法命名規(guī)范- 駝峰命名，不能出現(xiàn)下劃線**

- **類屬性規(guī)范- 類屬性和類方法一致,統(tǒng)一使用駝峰**

- **函數(shù)命名- 小寫字母加下劃線**

- **變量命名規(guī)范- 產(chǎn)品中不涉及到全局變量,局部變量不做強制要求,建議使用下劃線**

- **后臺控制器里給列表賦值的變量都用list, 單一數(shù)據(jù)讀取、保存都用data,其他臨時變量 最好不要使用這兩個，以免造成沖突**

#### 前端編碼規(guī)范

- **請參考主題模板開發(fā)的[前端技術(shù)說明文檔](http://shsolar88.cn/doc/904.html)**

## 數(shù)據(jù)庫規(guī)范

- **所有的字段必須添加注釋**

- **字段名小寫，多關(guān)鍵字使用下劃線分割（關(guān)鍵字盡量全稱）**

- **所有字段不允許 NULL值**

- **字段長度定義（TODO: 具體常用的長度定義）**

- **數(shù)據(jù)表引擎 InnoDB**

- **各表 status 字段來標(biāo)注數(shù)據(jù)狀態(tài)，業(yè)務(wù)狀態(tài)請使用其他字段；status字段類型 為帶符號的 tinyint**

```
    -1 已刪除  0 被禁用  1 正常  2 未審核
  ```

如果還需要其他的數(shù)據(jù)狀態(tài) 請先判斷該狀態(tài)的數(shù)據(jù)是有用的數(shù)據(jù)還是無意義的數(shù)據(jù)

```
    有用的數(shù)據(jù)狀態(tài) > 2  無意義的數(shù)據(jù)狀態(tài) < -1  所有的刪除（除開清空回收站操作） 請 標(biāo)記status 為 -1
  ```

## 文檔規(guī)范

- **功能模塊文檔**

- **文件注釋**

- **方法注釋**

- **函數(shù)注釋**

- **代碼塊注釋**

注釋必須有 @author 項，方便在遇到問題時候找到作者調(diào)整。

阿帕云引擎

云引擎受控端

云引擎控制器

云引擎開放API

文檔首頁

云業(yè)務(wù)管理系統(tǒng)（國內(nèi)版）

開發(fā)規(guī)范

18+

1000+

30+

5+