駱駝式命名法
駱駝式命名法就是當變量名或函數名是由一個或多個單詞連結在一起,而構成的唯一識別字時,第一個單詞以小寫字母開始;從第二個單詞開始以後的每個單詞的首字母都採用大寫字母。
小駝峯法: 除第一個單詞之外,其他單詞首字母大寫。
大駝峯法: 把第一個單詞的首字母也大寫了。
- 文件命名規範
1.文件命名以大駝峯法作爲命名規範,例如:IndexController.cs,示例圖如下:
2.Services層的文件以Service作爲後綴,例如:AccountService.cs,示例圖如下:
3.Repositories層的文件以Repository作爲後綴,例如:AccountRepository.cs,示例圖如下:
- Class內私有變量命名規範
Class內私有變量以下劃線+小駝峯法作爲命名規範,例如:_loginService,示例圖如下:
- 全局公共靜態變量命名規範
全局公共靜態變量以大駝峯法作爲命名規範,例如:DefaultDateTime,示例圖如下:
- 局部公共變量命名規範
局部公共變量以大駝峯法作爲命名規範,例如:IsActivity,示例圖如下:
- 常量命名規範
常量以下劃線分割大寫字母的方式作爲命名規範,例如:IS_DEBUG,示例圖如下:
- 公共函數命名規範
公共函數以大駝峯法作爲命名規範,參數以小駝峯法作爲命名規範,
例如:ResponseResult<bool> Insert(List<CategoryModel> modelList),示例圖如下:
- 異步函數命名規範
異步函數以Async作爲後綴,例如:SetStickAsync,示例圖如下:
- model字段命名規範
- Viewmodel字段命名規範
View model字段以小駝峯法作爲命名規範 && class名稱以ViewModel結尾,
例如:PersonalMsgCountListViewModel,示例圖如下:
- DTOmodel字段命名規範
DTO model字段名稱與數據庫的字段保持一致,例如:AllotLogDTO,示例圖如下:
- 枚舉命名規範
枚舉以大駝峯法+Enum作爲命名規範,例如:ResponseMessageEnum,示例圖如下:
- 枚舉代碼規範
枚舉必須要有0的相關值,每個枚舉值必須填充4項:Key、Value、描述、註釋,Key只能包含英文字母、下劃線、數字,示例圖如下:
- 註釋要求
每個函數必須填寫註釋信息,示例圖如下:
- Sql語句代碼規範
Sql語句編寫爲帶參的語句,動態sql組裝請使用StringBuilder,示例圖如下: