软件开发规范参考文档
代码走读检查列表
Pre-review checklist 准备工作
2.1Practical considerations 通常的考虑
1. Have you been provided with a design document to understand the code ? Is the design document up-to-date (latest version) ? 你是否得到一份解释代码的设计文档?设计文档是否最新的?
2. Does the design document explain 设计文档是否做了如下解释:
- program architecture ? 程序结构?
- module breakup and functionality ? 模块是否已经完成和函数化?
- task breakup ? 任务完成了吗?
- each routine in pseudo-code form ? 每个函数都有伪代码?
3. Has the code been compiled with strict warning and error checking enabled (-Wall and -Werror options); have all compilation warnings and errors been removed ? 代码是否已经被使用严格的告警和错误检查编译过?所有的编译告警和错误都已经修改?
4. Has the code been compiled with a C++ compiler in addition to a C compiler ? 代码是否使用带C++特性的C编译器编译?
2.2Program (product) architecture 程序结构
1. Is the overall organization of the code clear, including a good architectural overview and justification ? 所有代码的结构是否清晰,具有良好的结构外观和整齐?
2. Are modules well defined, including their functionality and interfaces to other modules ? Is the task/process breakup of the modules clear ? 所有的模块都定义得很好,包括函数和外部接口?任务/进程 把模块分解清楚?
3. Are all the functional requirements covered sensibly, by neither too few nor too many modules ? 所有的功能需求都明显的覆盖,过多还是过少?
4. Is the top-level design independent of the OS/environment which will be used ? 高层设计是否独立于OS/环境?
5. Is the architecture designed to accommodate likely changes ? 结构设计是否能够满足变化?
6. Does the architecture describe how reused code will be made to conform to other architectural objectives 体系结构是否描述了如何把代码重用到其他体系结构中?
7. Does the whole architecture hang together conceptually ? 整个体系结构组合在一起,是否合理?
8. Are all major data structures described and justified ? 所有主要的数据机构是否描述清楚和合理的
9. Are data structures belonging to every module localised suitably so that they are accessed/modified by well-defined access routines ? 模块中所有的数据结构是否都定义为局部的,并且通过定义好的函数进行访问?
10. Is there a well-defined strategy to interface with external entities ? 是否为外部定义了良好的函数接口?
11. Are all interfaces modularized so that changes will not affect the rest of the code ? 所有的接口是否模块化,因此他们的修改不影响其他代码?
12. Are memory usage estimates and a strategy for memory management described and justified ? 内
代码检查列表序号 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 所属类别 命名 注释 注释 注释 注释 重要程度 重要 重要 ...
代码走读检查表模板_IT/计算机_专业资料。编程开发OA代码检查列表序号 1 所属类别 命名 重要程度 重要 检查项 命名规则是否与所采用的规范保持一致? 所有的源文件...
代码走读检查表模板_计算机软件及应用_IT/计算机_专业资料。代码检查列表序号 1 所属类别 命名 重要程度 重要 检查项 命名规则是否与所采用的规范保持一致? 所有的...
4页 免费 软件代码走读教材 22页 1财富值 代码走查报告 22页 免费 代码走读检查综合评价表-V... 15页 1财富值 很好的代码检查表 4页 2财富值搜...
代码走读检查表模板 4页 免费评审检查表---very important ...
状态: 草稿[ ] 正式[ √ ] 修改[ ] 代码走读记录作者: <Author> 修订文档...代码走读检查表 暂无评价 4页 免费 软件代码走读教材 22页 1下载券 VB编写代码...
代码走读检查表模板 4页 免费 很好的代码检查表 4页 1下载券 C++代码走查Check...代码走读原则一:准备工作 结论 (是 / 否) 1:目录层次结构是否遵循标准? 2:...
代码走读记录与评估_计算机软件及应用_IT/计算机_专业资料。程序功能项(合格情况...代码走读记录 1页 免费 代码走读检查表 暂无评价 4页 免费 软件代码走读教材 ...
代码走读_IT/计算机_专业资料。代码走读 (1) 代码走读都有哪些内容? 代码走读...代码走读检查表模板 4页 免费 走读 5页 免费 在校生走读申请一 3页 免费 代码...
第1章 代码复查简单介绍代码复查(Code Review),又叫“代码审查”,其基本思想就...代码走读检查表 暂无评价 4页 免费 喜欢此文档的还喜欢 Code Review工具Jupiter...
热门文档