4.软件开发代码管理规范

2011年5月13日 软件项目管理培训之三——代码管理规范 5
对代码管理的认识误区
误区1 代码体现个人风格， 误区1：代码体现个人风格，统一规范扼杀创造性 骑士时代的落后观点—— ——团队远比个人重要 骑士时代的落后观点——团队远比个人重要 误区2 代码风格只是个人习惯， 误区2：代码风格只是个人习惯，无需刻意统一 软件价值观点：代码也是一种商品， 软件价值观点：代码也是一种商品，统一规格很重要 软件出口观点：欧美市场、 软件出口观点：欧美市场、日本市场都要求规范代码 误区3 代码规范只是细枝末节， 误区3：代码规范只是细枝末节，提高精妙程度才重要 天才培养模式和蚂蚁工场模式： 天才培养模式和蚂蚁工场模式：规范胜于精妙 武林高手与前军万马：还记得郭靖和杨过吗？ 武林高手与前军万马：还记得郭靖和杨过吗？ 误区4 误区4：代码规范只是规定如何编写代码 代码规范包括编写代码、 代码规范包括编写代码、维护代码和管理代码 代码＝思想＝ 代码＝思想＝良好的文字作品
2011年5月13日
软件项目管理培训之三——代码管理规范
12
代码调试规范
如何设计Error 如何设计Error Code Code的定义规则 Error Code的定义规则 Code的使用规则 Error Code的使用规则 Code的分析规则 Error Code的分析规则 如何添加调试代码和调试输出 预编译宏定义的使用： 预编译宏定义的使用：代码运行的开关 调试输出的设计： 调试输出的设计：文件输出和界面输出 调试代码运行控制：Debug版和Release版 版和Release 调试代码运行控制：Debug版和Release版
2011年5月13日
软件项目管理培训之三——代码管理规范
13
内容提要
代码管理的作用和内容 代码编写与调试的规范 代码控制与管理的规范
2011年5月13日
软件项目管理培训之三——代码管理规范
14
代码控制的规范
软件开发的分工 每一个模块、 每一个模块、文件均指定固定人员 首要的工作是确定接口 次要的工作是确定数据结构和相关常量定义 代码权限的控制 应用VSS VSS建立代码管理环境 应用VSS建立代码管理环境 针对Project Project分配合理的权限 针对Project分配合理的权限 保证每个人规范的使用Check 保证每个人规范的使用Check in/Check out
18
Thanks for your time! Questions & Answers
2011年5月13日
软件项目管理培训之三——代码管理规范
19
2011年5月13日
软件项目管理培训之三——代码管理规范
17
结束语
代码管理——软件生产线的操作规范 软件生产线的操作规范 代码管理 优秀的程序员＝ 优秀的程序员＝优秀的作家 代码管理：团队协作 思想交流——产业价 代码管理：团队协作——思想交流 思想交流 产业价 值
2011年5月13日
软件项目管理培训之三——代码管理规范
2011年5月13日
软件项目管理培训之三——代码管理规范
11
如何减少出错概率
示例1 示例1：计算窗口的宽高比 usWHRatio = usWeight / usHeight; 可能出错的机会： 可能出错的机会：除零错 如何保证出错概率少？ 如何保证出错概率少？ 示例2 示例2：如何处理各类可能的异常 返回值控制： 返回值控制：Error Code C++中的Catch…Try…应用 中的Catch…Try… C++中的Catch…Try…应用 应用界面中的消息框
2011年5月13日
软件项目管理培训之三——代码管理规范
16
案例剖析——代码管理示范 案例剖析——代码管理示范 ——
VSS的架构示例 VSS的架构示例 建立目录结构、 建立目录结构、增加管理文件 分配权限、 分配权限、添加版本控制 VSS的应用示例 VSS的应用示例 如何Check 如何Check in/Check Out 如何增加版本说明 如何实现开发过程的可重复
2011年5月13日
软件项目管理培训之三——代码管理规范
6
内容提要
代码管理的作用和内容 代码编写与调试的规范 代码控制与管理的规范
2011年5月13日
软件项目管理培训之三——代码管理规范
7
代码编写规范的内容
命名规范 如何定义代码文件名与模块名 如何定义变量与数据结构名称 如何定义函数名与接口名称 语句编写规范 Tab、空格、 Tab、空格、括号的使用 语句排列与空行 代码注释规范 文件头注释与函数头注释 函数内部注释
代码——产品升级和系统维护的对象 代码——产品升级和系统维护的对象 ——
代码注释与说明， 代码注释与说明，提高软件的可复用性 系统设计与结构， 系统设计与结构，提高功能的可扩展性 版本控制与备份， 版本控制与备份，保持软件团队的价值
2011年5月13日
软件项目管理培训之三——代码管Байду номын сангаас规范
3
软件开发的艺术性分析
软件项目管理培训讲座
系列之四——代码管理规范 系列之四——代码管理规范 ——
内容提要
代码管理的作用和内容 代码编写与调试的规范 代码控制与管理的规范
2011年5月13日
软件项目管理培训之三——代码管理规范
2
代码管理的作用
代码——软件功能和性能的核心 代码——软件功能和性能的核心 ——
流程与结构， 流程与结构，软件功能的基础 算法与接口， 算法与接口，软件性能的基础 安全与稳定， 安全与稳定，软件维护的基础
一种需求可用多种思路实现
不同的系统平台、 不同的系统平台、不同的应用环境
一种思路可用多种方法实现
千差万别的算法思想
一种方法可用多种工具实现
C/C++、 Basic、Delphi、ASP、 C/C++、Visual Basic、Delphi、ASP、C#
一种实现可用多种方法评测
黑盒测试、白盒测试、压力测试、 黑盒测试、白盒测试、压力测试、安全测试
软件开发的艺术性＝＝不确定性 软件开发的艺术性＝＝不确定性 ＝＝
规范的代码折射相同的思想
2011年5月13日 软件项目管理培训之三——代码管理规范 4
代码管理的内容
代码编写规范 变量命名与数据结构定义 空格、括号、Tab的使用 空格、括号、Tab的使用 注释、 注释、说明的使用 代码调试习惯 如何增加调试输出或添加调试开关？ 如何增加调试输出或添加调试开关？ 如何保证调试过程的稳定？ 如何保证调试过程的稳定？ 代码提交规范 版本的定义与应用 代码的集中管理， 代码的集中管理，Check in/Check out 代码维护习惯 影响代码运行的环境因素 影响代码性能的工作方法
2011年5月13日 软件项目管理培训之三——代码管理规范 8
案例分析
代码编写规范示例 代码片断示例 分析和总结 良好的代码规范是团队精神和职业素养的体现 习惯的培养是保证团队成功的关键
2011年5月13日
软件项目管理培训之三——代码管理规范
9
代码编写的工程习惯
习惯1 使用空格和空行， 习惯1：使用空格和空行，增进易读性 习惯2 习惯2：注重多重嵌套语句的起止注释 习惯3 避免使用过于复杂、 习惯3：避免使用过于复杂、难懂的算法 习惯4 习惯4：尽可能不要使用递归
2011年5月13日
软件项目管理培训之三——代码管理规范
10
代码调试规范的内容
如何尽可能的减少出错概率？ 如何尽可能的减少出错概率？ 增加对数据合法性的检查 增加对各类异常的处理 增加关键处理步骤的调试输出 代码调试规范 出错控制机制的设计： Code如何定义 出错控制机制的设计：Error Code如何定义 调试输出机制的设计：如何Output Output、 调试输出机制的设计：如何Output、Return 调试代码的编写规范
2011年5月13日
软件项目管理培训之三——代码管理规范
15
代码控制的常见错误
重复分工的危害 多人同时写一个文件或一个函数造成冲突 多人Check 多人Check in/Check out 造成代码丢失 资源的重复投入和浪费 不注重权限和版本的危害 无法重复、 无法重复、永远丢失的代码 无法跟踪、 无法跟踪、无法重现的错误 无法控制、 无法控制、无法管理的团队