第七次团队作业：Alpha冲刺 代码规范与计划

这个作业属于哪个课程	2018级计算机和综合实验班
这个作业要求在哪里	第七次团队作业：Alpha冲刺
这个作业的目标	开发本小组选择的图书馆打卡小程序
作业正文	如下

1、排版

• 1-1:程序块要采用缩进风格编写,缩进的空格数为4个。
• 1-2:较长的语句要分成多行书写，长表达式要在低优先级操作符处划分新行操作符放在新行之首，划分出的新行要进行缩进，使排版整齐，语句可读。
• 1-3:循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
• 1-4:不把多个短句放在同一行
• 1-5:对齐仅使用空格
• 1-6:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。
• 1-7:一行程序80字符最佳

2、注释

• 2-1:说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
• 2-2:源文件头部应进行注释，列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
• 2-3:函数头部应进行注释，列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
• 2-4:对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
• 2-5:注释与解释内容缩进一致
• 2-6:对分支语句和变量定义必须注释
• 2-7:最好是代码清晰易懂，减少注释

3、标识命名符

• 3-1:标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。
• 3-2:命名使用非常规书写需要注释
• 3-3禁止单个字母的变量，但是可以吧i，j，k作为循环变量
• 3-4命名规范需要和系统一致

4、可读性

• 4-1:注意运算符的优先级
• 4-2:避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

5、变量、结构

• 5-1:去掉无用公共变量
• 5-2:明确公共变量的含义以及作用
• 5-3:防止公共变量和局部变量同名
• 5-4:变量使用前必须初始化

6、函数、过程

• 6-1:明确函数功能，精确实现函数设计
• 6-2:使用全局变量的时候需要使用PV进行保护

7、可测性

• 7-1:在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明。
• 7-2:在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号。
• 7-3:编程的同时要为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明。测试代码部分应作为（模块中的)一个子模块，以方便测试代码在模块中的安装与拆卸〈通过调测开关)。
• 7-4:在进行集成测试/系统联调之前，要构造好测试环境、测试项目及测试用例，同时仔细分析并优化测试用例，以提高测试效率。
• 7-5:使用断言来发现软件问题，提高代码可测性。