码到成功——代码规范与计划
| 这个作业属于哪个课程 | 班级的链接 |
|---|---|
| 这个作业要求在哪里 | 作业要求的链接 |
| 这个作业的目标 | 计划阶段4天，Alpha冲刺阶段共计10天，冲刺阶段要求每天进行小组会议，讨论当前项目昨日进展、存在问题、今日安排（安排需要组长根据情况灵活修改）冲刺阶段每天发布一篇随笔要求包括当天会议照片、会议内容以及项目燃尽图。 |
| 作业正文 | .... |
| 其他参考文献 | ... |
一.代码规范
1.排版
1.1 程序块采用缩进风格编写，缩进的空格数为jupyter的默认缩进空格数
1.2 相对独立的程序块之间必须空行
1.3 变量说明跟在语句的后方，通过注释的形式说明，注释与代码之间需要以空格间隔
1.4 使用到等号时，等号前后需要添加空格
2.注释
2.1 对于非基础语句必须添加注释，方便组员阅读
2.2 对函数名和变量名需要添加注释，方便组员明白其含义
2.3 注释内容要准确清晰，不可太简写
2.4 对于使用首字母形式的变量名，必须说明原英文名是什么，以及中文含义是什么
3.标识符命名
3.1 函数名统一通过百度翻译翻译成英文获得，并将空格转化成下划线
3.2 变量名用百度翻译翻译成英文获得，如果太长，则使用翻译成英文单词的首字母大写，空格则以下划线代替
3.3 SQL语句统一命名为sql_xxx的形式
4.可读性
4.1 注意运算符的优先级，避免使用默认优先级
5.变量、结构
5.1 去掉没有用的公共变量
6.函数、过程
6.1 对所调用函数的错误返回码要仔细、全面地处理
6.2 明确函数功能，精确（而不是近似）地实现函数设计
7.可测性
7.1 打印信息
在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号。
7.2 调测开关
在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明。
7.3 单元测试
编程的同时要为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明。测试代码部分应作为（模块中的）一个子模块，以方便测试代码在模块中的安装与拆卸（通过调测开关）。
8.程序效率
8.1 编程时要经常注意代码的效率。
8.2 在保证软件系统的正确性、稳定性、可读性及可测性的前提下，提高代码效率。
8.3 局部效率应为全局侠侣服务，不能因为提高局部效率面对全局效率造成影响。
9.质量保证
9.1 在软件设计过程中构筑软件质量。
9.2 代码质量保证优先原则。
9.3 只引用属于自己的存贮空间。
9.4 防止引用已经释放的内存空间。
9.5 防止内存操作越界。
9.6 认真处理程序所能遇到的各种出错情况。
9.7 系统运行之初，要初始化一关变量及运行环境，防止未经初始化的变量被引用。
9.8 系统运行之初，要对加载到系统中的数据进行一致性检查。
9.9 不能随意改变与其他模块的接口。
9.10 充分了解系统的接口之后，再使用系统提供的功能。
10.代码编辑、编译、审查
10.1 通过代码走读及审查方式对代码进行检查。
10.2 测试产品之前，应对代码进行抽查。
10.3 编写代码时要注意随时保存，并定期备份，防止由于端点，硬盘损坏等原因造成代码丢失。
10.4 合理地设计软件系统目录，方便开发人员使用。
11.代码测试、维护
11.1 单元测试要求至少达到语句覆盖
11.2 单元测试开始要跟踪每一条语句，并观察数据流及变量变化。
11.3 清理、整理或优化后的代码要经过审查及测试。
11.4 代码版本升级要经过严格测试。
11.5 使用软件工具对代码进行维护。
二.冲刺计划
1.在前4天的计划阶段，分析开发时可能会遇到的问题，并研究开发时所需要使用的工具。
2.在10天的冲刺阶段，每天开会分析当天遇到的问题并在自己有所收获时和其他组员分享自己在编程过程中的收获，尤其是编程技术上的收获。
3.前端：在冲刺阶段的前7天完成对界面的开发。
4.前端：在冲刺阶段的第8到9天完成前端对后端接口的调用。
5.前端：在冲刺阶段的最后一天完善界面和对后端接口的调用。
6.后端：在冲刺阶段的前2天，后端完成服务器的部署。
7.后端在冲刺阶段的第3到5天，后端完成基本函数的封装。
8.后端在冲刺阶段的第6到8天，后端完成将函数做成接口。。