.net代码规范

骆驼式命名法

　　骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起，而构成的唯一识别字时，第一个单词以小写字母开始；从第二个单词开始以后的每个单词的首字母都采用大写字母。　

　　　　小驼峰法： 除第一个单词之外，其他单词首字母大写。

　　　　大驼峰法： 把第一个单词的首字母也大写了。

 

• 文件命名规范

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，示例图如下：