添加 docs/后端代码规范文档.md
This commit is contained in:
parent
c7940da687
commit
15d6a73ac1
12
docs/后端代码规范文档.md
Normal file
12
docs/后端代码规范文档.md
Normal file
@ -0,0 +1,12 @@
|
||||
1.命名规范:
|
||||
全局采用小驼峰命名:aBbCc,特定情况除外,例如:.NET编译器要求方法名为大驼峰
|
||||
Controllers下控制器请采用:自定义命名+Controller
|
||||
Services下服务请采用:自定义命名+Service
|
||||
Dtos下模型请采用:自定义命名+Dto
|
||||
|
||||
2.文件(夹)规范:
|
||||
Controllers:写控制器、Actions,用于写处理请求相关代码,禁止直接进行数据库交互。若要交互数据库,请先在services内写好业务逻辑再进行调用
|
||||
Services:用于写业务逻辑,数据库交互相关。
|
||||
Dtos:用于存放不同层级之间数据类型转换相关模型类,例如返回用户信息,需要剔除密码等敏感信息,不可直接返回数据库模型类。
|
||||
Models:数据库模型类,一般情况请勿改动
|
||||
Appsettings:此文件用于储存配置文件,数据库连接字符串,redis连接字符串,配置相关内容请写在此文件内,禁止硬编码到业务代码内
|
||||
Loading…
Reference in New Issue
Block a user