代码规范

Posted 2021-06-12 重振嵌入式荣光

| 这个作业属于哪个课程 | [2018级计算机和综合实验班](https://edu.cnblogs.com/campus/fzzcxy/2018CS/) |
| ---------- | ------ |
| 这个作业要求在哪里 | [第八次团队作业：Beta冲刺](https://edu.cnblogs.com/campus/fzzcxy/2018CS/homework/12075) |
| 这个作业的目标 | 代码规范        |
| 作业正文 | 见下文 |
|仓库地址| [Gitee](https://gitee.com/group21-sudo/beta)|

 

## 前端规范

* js中的变量名与数据库中变量名保持一致，其它变量名使用驼峰命名法且命名应清晰明了，有明确含义。
* 变量命名不使用拼音和中文命名。
* 使用const声明常量
* 采用缩进风格编写，使用Tab进行缩进。
* 属性统一使用双引号

## 后端规范

- 使用MVC架构。
- 实体类中的变量名与数据库中变量名保持一致，其它变量名使用驼峰命名法且命名应清晰明了，有明确含义，且不使用拼音和中文命名。
- 采用缩进风格编写，使用Tab进行缩进。
- 程序中关系较密切的代码应尽可能相邻。
- 防止局部变量与公共变量同名。
- 一个函数应仅完成一个功能，且函数规模尽量限制在200行内。
- 函数名应准确描述函数的功能。
- 编程时要经常注意代码的效率。
- 对于不很经常被调用的函数，不应该花过多的时间进行优化。
- 尽量减少循环嵌套层次。
- 在效率损失不多的情况下保证代码简单可读。

## 硬件规范

- 尽量选用成本低的硬件设备，尽可能发挥出性能。
- 硬件连线时，VCC采用红色线，GND采用黑色线。
- 为保证程序的易移植性，尽量将与硬件相关的变量定义使用宏定义的方式。
- 采用缩进风格编写，使用Tab进行缩进。
- 防止局部变量与公共变量同名。
- 变量命名不使用拼音和中文。
- 在效率损失不多的情况下保证代码简单可读。