完善编码规范

This commit is contained in:
2023-10-27 15:51:20 +08:00
parent c48ec651bd
commit 5e598717f4

View File

@ -20,9 +20,12 @@
- bool 类型的属性不需要添加属性值 - bool 类型的属性不需要添加属性值
- class 必须单词全字母小写,单词之间以 '-' 分隔 - class 必须单词全字母小写,单词之间以 '-' 分隔
- id 必须保证同一个页面内唯一使用小驼峰式命名camelCase - id 必须保证同一个页面内唯一使用小驼峰式命名camelCase
- - 如果使用第三方组件库,尽可能二次封装组件库,减少自定义组件的使用。
### CSS ### CSS / LESS / SCSS
- 禁止使用 style 行内样式
- class 样式尽可能使用 Tailwind CSS 或 UnoCss减少自定义 class 样式编写
### JavaScript ### JavaScript
@ -44,13 +47,16 @@
## 服务端 ## 服务端
### C# ### C# / ASP.NET
- record 名称、结构体名称、类名、公有属性、方法名称、文件名使用 Pascal 式命名 - record 名称、结构体名称、类名、公有属性、方法名称、文件名使用 Pascal 式命名
- 接口 第一个字母应为大写 I - 接口 第一个字母应为大写 I
- private 和 internal 属性使用小驼峰式命名camelCase或者开头添加 \_ - private 和 internal 属性使用小驼峰式命名camelCase或者开头添加 \_
- 方法参数使用小驼峰式命名camelCase命名 - 方法参数使用小驼峰式命名camelCase命名
- 所有 ApiController 必须返回 ResultDto 类型,并且被 Ok() 函数包裹 - 所有 ApiController 必须返回 ResultDto 类型,并且被 Ok() 函数包裹
- 尽可能使用公司内部 NuGet 包中的方法,减少自定义方法的实现
- 编写 Controller 中的方法,需要尽可能遵守 RESTful 风格,要有默认的 Get Post Put Delete 等方法,
- Program.cs 文件避免出现业务逻辑代码
## 工作目录 ## 工作目录