第八次团队作业：代码规范

Posted 2021-06-13 永不加班hhh

这个作业属于哪个课程	2018级计算机和综合实验班
这个作业要求在哪里	作业要求
作业正文	如下所示
这个作业的目标	规范代码格式

代码规范

1、排版

• 要保持页面整洁性

• 对齐只是用空格键，不使用tab键。

• 程序块要采用缩进风格写，缩进时使用tab。

• 函数或过程中的参数较长，要进行适当的划分。

• 相对独立的程序块之间，变量说明之后必须加空行。

2、注释

• 注释应在代码的上方(空行)或者右方。

• 说明性文件必须要注释。

• 代码和注释同步更新，并且注释内容要避免歧义。

• 在注释中不使用缩写。

3、标识符命名

• 标识符命名要清晰明了，缩写要通俗易懂。

• 不可使用数字或者奇怪的字符定义标识符。

4、可读性

• 注意运算符的优先级，避免使用默认优先级。

• 避免使用不易理解的数字。

5、变量、结构

• 防止局部变量与公共变量同名。

• 结构功能要单一。

6.函数、过程

• 避免设计多参数函数。

• 减少函数间的递归调用。

• 一个函数仅完成一个功能。

• 明确函数功能，精确实现函数设计。

• 不使用无意义或者含义不清的动词给函数命名。

7、可测性

• 对较为复杂的断言加上明确的注释。

• 在进行集成测试联调之前，要构建好测试环境、测试项目及测试用例、同时仔细分析并优化测试用例，以提高测试效率。

8、程序效率

• 编程时要注意代码的效率。

• 局部效率应为全局效率服务。

9、质量保证

• 不可随意改变与其他模块的接口。

• 只引用自己的存贮空间，并且防止引用已经释放的内存空间。

• 系统运行之初，要对加载到系统中的数据进行一致性检查。

10、代码编辑、编译、审核

• 合理地设计软件系统目录，方便开发人员使用。

• 使用代码检查工具对源程序检查，使用软件工具进行代码审查。

• 编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。

11、代码测试、维护

• 仔细处理代码的边界情况。

• 使用软件工具对代码经过严格测试。

• 在编码阶段就要开始对代码进行单元测试。

• 清理、整理或优化后的代码要经过审查及测试。

12、宏

• 使用时，不允许参数发生变化。

• 将宏定义的多条表达式放在大括号中。

• 用宏定义表达式时，要使用完备的括号。