第八次团队作业:代码规范
这个作业属于哪个课程 | 2018级计算机和综合实验班 |
---|---|
这个作业要求在哪里 | 第八次团队作业:Beta冲刺 |
Vue前端规范
命名规范
-
id、class等采用 驼峰命名法
-
命名中尽量避免使用中文拼
排版规范
html 规范
- 普通标签使用小写,外部引入的组件标签使用大写
- 属性的定义,统一使用双引号。
- wxml标签可以单独出现的情况,尽量单独出现
css规范
- 为了保证适配,使用em
- CSS代码需有明显的代码缩进
- 简写属性
Js 规范
- 变量名以及函数名统一采用驼峰命名法
- 类的命名首字母需大写
- 常量用const 声明
- prop 的定义应该尽量详细
- 方法参数在定义和传入时,多个参数逗号后边必须加空格
SpringBoot后端规范
命名规范
- 命名中尽量避免使用中文拼
- 模块名称:{项目名称}-
- 项目目录遵循Maven约定目录格式
编码规范
-
项目基本包:com.company.{项目英文名(较长时适当简化)}.
-
统一使用SLF4j接口
-
接口地址定义表明用意,简洁,无歧义
-
控制类的顶层地址格式:/{顶层分类名},例如:/library 人员库相关接口的顶层地址
-
接口定义使用Swagger的API注解说明