# dotnet_dev_specifiaction

**Repository Path**: vintom/dotnet_dev_specification

## Basic Information

- **Project Name**: dotnet_dev_specifiaction
- **Description**: .NET后端开发规范，包括数据库设计规范，代码编写规范，源代码管理规范等
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-11
- **Last Updated**: 2023-04-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: dotNET, Database, Git

## README

# .NET后端开发规范

#### 内容介绍
.NET后端开发规范，包括数据库设计规范，代码编写规范，源代码管理规范等。所有规范来源于个人工作总结以及个人所了解到的一些优秀开发者提倡的规范，是否合理仅供参考。

### 1. .NET基础开发规范

#### 1.1 命名规范

- 所有命名最好符合英文语义，一个好的命名比起增加注释更能够提升代码的可读性

+ 类型名称的首字母必须大写，包括类、枚举、结构，采用PascalCasing风格
+ 方法，公开(public)、保护(protected)字段和属性均采用PascalCasing风格
+ 私有(private)字段最好设置为只读(readonly)，命名风格建议使用：_fileldName
+ 自定义的异常类，必须以Exception结尾，最好增加注释说明异常场景
+ 抽象类或基类命名必须以Base开头
+ 接口必须以I开头
+ 私有静态字段命名风格建议使用：s_fieldName

#### 1.2 访问修饰符使用规范

- public：公有访问，不受任何限制
- protected：保护访问，只限于本类和子类访问，实例不能访问。
- private：私有访问，只限本类访问，子类和实例都不能访问
- internal：内部访问，只限本项目访问，其它不可访问
- protected internal：内部保护访问，只限于本项目中本类和子类访问，其它不可访问

#### 1.3 何时使用密封类和密封方法

#### 1.4 何时使用Const和Readonly修饰符

#### 1.5 何时使用枚举类型和结构类型



### 2. 源代码管理规范

#### 2.1 分支命名规范

#### 2.2 代码提交规范

关于代码提交时增加的备注是很重要的一部分，有利于对于代码变更的追溯。总的来说，代码的提交可分为以下三类：

- feat(feature)：新功能，新需求
- fixed：bug修复
- refactor：重构，代码优化，不涉及修复bug及完善新功能所做的修改

### 3. 数据库设计规范

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request
5.  如果本项目对您有所帮助，将会很开心收到您的star