先後端命名最佳實踐

命名規範

最佳實踐

命名是個困擾了我好久的問題，各類方式都試過，如今總結固化一下做爲一個大結論。

原則：優先考慮小寫、下劃線，不用中劃線。

1. 文件夾 小寫 下劃線

2. 文件名 小寫 下劃線

3. 樣式名 小寫 下劃線

4. 類名 首字母大寫 駝峯

5. 函數名 駝峯

6. 變量名 駝峯

7. 常量名 全大寫 下劃線

8. 數據庫名 小寫 下劃線

9. 數據庫表 小寫 下劃線

10. 字段名 小寫 下劃線

緣由分析

用小寫緣由

1. Linux 系統是大小寫敏感的，而 Windows 系統和 Mac 系統大小寫不敏感
2. 某些系統（Ubuntu）的用戶目錄首字母大寫（早期 Unix 系統 ls 大寫的排前面），便於區分
3. 易讀、易寫

用下劃線緣由

1. 樣式中使用容易複製，點擊一次便可選中
2. 變量不支持中劃線，支持下劃線
3. 所有統一成下劃線，省事省心

項目交付標準

低級

實現所有功能需求

解決所有 bug

合格

實現所有功能需求

解決所有 bug

代碼格式統一(eslint 檢測)、命名規範統1、極其詳細的註釋，代碼合理的封裝、隔離

走完前端上線必檢清單，走完後端上線必檢清單

需求文檔、設計圖、前端說明文檔、後端接口文檔、測試報告齊全

標準

實現所有功能需求

解決所有 bug

代碼格式統一(eslint 檢測)、命名規範統1、極其詳細的註釋，代碼合理的封裝、隔離

走完前端上線必檢清單，走完後端上線必檢清單

需求文檔、設計圖、前端說明文檔、後端接口文檔、測試報告齊全

後端接口單元測試報告、後端接口壓力測試報告、運維部署說明