程式碼命名規範
阿新 • • 發佈:2021-06-17
一、資料庫命名規範
1.1 資料表命名規範
-
採用26個英文字母(區分大小寫)和0-9的自然數(經常不需要)加上下劃線'_'組成,命名簡潔明確,多個單詞用下劃線'_'分隔,例如auth_user、auth_group等;
- 全部小寫命名,禁止出現大寫
- 禁止使用資料庫關鍵字,如:name,time ,datetime,password等;
- 表名稱不應該取得太長(一般不超過三個英文單詞);
- 表的名稱一般使用名詞或者動賓短語;
- 用單數形式表示名稱,例如,使用 employee,而不是 employees;
- 表以及欄位必須填寫描述資訊(使用SQL語句建表時);
1.2 函式命名規範
二、前端命名規範
2.1React命名規範
- 元件名稱全部大寫字母開頭,例如antd的Modal、Message、Button等;
- 資料夾以xxx-xxx命名,例如ant-design-pro、realtime-data等;
- 檔案採用駝峰命名;
三、後端命名規範
3.1java命名規範
- 方法命名 返回列表的 +s
public List<ParameterMapping> getParameterMappings()
- 成員屬性命名 collection +s
private List<ResultMapping> resultMappings;
- map成員
Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<>()
- 方法名稱,做到望文生義 不要縮寫。例如:getUserById、getUserByLoginName、getUerList/getUsers