.Net 个人总结的代码规范

Posted 2021-11-09 シ゛甜虾

开发的项目要使用代码托管服务，即使公司没有也要自己搭建一个，我会使用GitLab和SVN，下面有搭建教程

Centos8安装GitLab14.2开源代码托管工具_シ❤゛甜虾的个人博客-CSDN博客_centos8安装gitlab

SVN服务器搭建，以及客户端配置 以Windows server为例 团队协作 文档共享 版本管理_シ❤゛甜虾的个人博客-CSDN博客

代码规范通过举例说明，仅是我个人总结，还希望大家批评指导

举例说明

1、项目文件夹命名

全部使用小写不使用下划线等特殊字符

例：

edgeservice

2、项目备份说明(正常使用的代码托管，备份的频率会很低)

项目文件夹命名加下划线加日期，然后生成压缩包

例：

edgeservice_20210922.rar

如果同一天有多个版本需要备份，当天的第二个备份包在后边加上序号

edgeservice_20210922_1.rar

3、项目命名

使用驼峰命名法

项目名称EdgeService

项目中的类库和主程序命名以项目名称.类库名称

EdgeService.WebApi

例：

4、类命名

使用驼峰命名法

❤服务类

WebApiService

❤控制类

EdgeController

❤实体表

DeviceInfoTable

❤实体表DTO

DeviceInfoTableDto

❤Webapi前端输入DTO

SetWorkmodeDto

❤Webapi前端返回DTO

SetWorkmodeResultDto