Alpha冲刺——代码规范与计划
香蕉牛奶——代码规范与计划
| 这个作业属于哪个课程 | https://edu.cnblogs.com/campus/fzzcxy/2018SE2 |
|---|---|
| 这个作业要求在哪里 | 作业要求 |
| 这个作业的目标 | 明确代码规范与计划以及本次冲刺的计划 |
| 作业正文 | 如下 |
| 其他参考文献 | 华为内部代码规范、阿里巴巴Java开发手册 |
一、代码规范
排版:
- 使用编辑器一键排版
注释:
- 添加注释，方便阅读
- 保证代码与注释相对应
- 注释内容简洁明了，避免歧义
- 注释写在要解释的代码上方
标识符命名:
- 标识符命名要清晰明了
- 风格一致：有明确含义、不使用缩写
- 使用有意义变量命名
可读性:
- 注意运算符优先级
- 使用有意义的标识
- 相关联的代码尽量放在一起
变量、结构:
- 减少使用无意义的公共变量
- 提前明确变量的意义
- 防止局部变量与公共变量同名
函数、过程:
- 明确函数功能
- 注意函数中局部变量的使用
- 注意接口函数调用的合法性
- 防止将函数的参数作为工作变量
- 规模控制在一定的范围内
- 函数与功能做到一对一，禁止多对多
- 函数设计尽量简单
- 减少函数间的依赖
可测性:
- 在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号
- 在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明
- 编程的同时为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明
- 测试前设计好明确的测试流程
程序效率:
- 编程时要经常注意代码的效率
- 在保证软件系统的正确性、稳定性、可读性及可测性的前提下，提高代码效率
- 减少嵌套循环的层次
- 后续测试中不断优化
质量保证:
- 设计过程中开始构筑软件质量
- 代码质量保证优先性原则
- 只引用属于自己的空间
- 防止引用已经释放的内存空间
- 减少内存的占用(及时分配/释放)
- 防止内存操作越界
- 系统运行之初，要初始化一关变量及运行环境，防止未经初始化的变量被引用
- 系统运行之初，要对加载到系统中的数据进行一致性检查
- 不能随意改变与其他模块的接口
- 充分了解系统的接口之后，再使用系统提供的功能
代码编辑、编译、审查:
- 通过代码走读及审查方式对代码进行检查
- 编写时随时保存、备份
- 测试产品之前，对代码进行抽查评审
代码测试、维护:
- 单元测试要求至少达到语句覆盖
- 单元测试开始要跟踪每一条语句，并观察数据流及变量变化
- 清理、整理或优化后的代码要经过审查及测试
- 发现错误立即改正
- 系统BUG修改前进行严格测试
二、计划
第一天：安装引擎，完成部分主界面
第二天：完成部分主界面
第三天：完成部分主界面
第四天：完成并检验主界面功能和完善样式
第五天：开始论坛版块的开设
第六天：完成论坛版块
第七天：完成论坛主题的开设
第八天：开始帖子发布的功能
第九天：完成帖子发布的功能
第十天：完善全部样式检验本次冲刺完成的内容
