软件开发代码管理规范

1、3/3/2022编辑ppt1软件项目管理培训讲座软件项目管理培训讲座系列之四系列之四代码管理规范代码管理规范3/3/2022编辑ppt2内容提要内容提要代码管理的作用和内容代码管理的作用和内容代码编写与调试的规范代码编写与调试的规范代码控制与管理的规范代码控制与管理的规范3/3/2022编辑ppt3代码管理的作用代码管理的作用代码代码软件功能和性能的核心软件功能和性能的核心流程与结构，软件功能的基础流程与结构，软件功能的基础算法与接口，软件性能的基础算法与接口，软件性能的基础安全与稳定，软件维护的基础安全与稳定，软件维护的基础代码代码产品升级和系统维护的对象产品升级和系统维护的对象代码注释与说

2、明，提高软件的可复用性代码注释与说明，提高软件的可复用性系统设计与结构，提高功能的可扩展性系统设计与结构，提高功能的可扩展性版本控制与备份，保持软件团队的价值版本控制与备份，保持软件团队的价值3/3/2022编辑ppt4软件开发的艺术性分析软件开发的艺术性分析一种需求可用多种思路实现一种需求可用多种思路实现不同的系统平台、不同的应用环境不同的系统平台、不同的应用环境一种思路可用多种方法实现一种思路可用多种方法实现千差万别的算法思想千差万别的算法思想一种方法可用多种工具实现一种方法可用多种工具实现C/C+C/C+、Visual BasicVisual Basic、DelphiDelphi、ASP

3、ASP、C#C#一种实现可用多种方法评测一种实现可用多种方法评测黑盒测试、白盒测试、压力测试、安全测试黑盒测试、白盒测试、压力测试、安全测试软件开发的艺术性不确定性软件开发的艺术性不确定性规范的代码折射相同的思想规范的代码折射相同的思想3/3/2022编辑ppt5代码管理的内容代码管理的内容代码编写规范代码编写规范变量命名与数据结构定义变量命名与数据结构定义空格、括号、空格、括号、TabTab的使用的使用注释、说明的使用注释、说明的使用代码调试习惯代码调试习惯如何增加调试输出或添加调试开关？如何增加调试输出或添加调试开关？如何保证调试过程的稳定？如何保证调试过程的稳定？代码提交规范代码提交规范

4、版本的定义与应用版本的定义与应用代码的集中管理，代码的集中管理，Check in/Check outCheck in/Check out代码维护习惯代码维护习惯影响代码运行的环境因素影响代码运行的环境因素影响代码性能的工作方法影响代码性能的工作方法3/3/2022编辑ppt6对代码管理的认识误区对代码管理的认识误区误区误区1 1：代码体现个人风格，统一规范扼杀创造性：代码体现个人风格，统一规范扼杀创造性骑士时代的落后观点骑士时代的落后观点团队远比个人重要团队远比个人重要误区误区2 2：代码风格只是个人习惯，无需刻意统一：代码风格只是个人习惯，无需刻意统一软件价值观点：代码也是一种商品，统一规格

5、很重要软件价值观点：代码也是一种商品，统一规格很重要软件出口观点：欧美市场、日本市场都要求规范代码软件出口观点：欧美市场、日本市场都要求规范代码误区误区3 3：代码规范只是细枝末节，提高精妙程度才重要：代码规范只是细枝末节，提高精妙程度才重要天才培养模式和蚂蚁工场模式：规范胜于精妙天才培养模式和蚂蚁工场模式：规范胜于精妙武林高手与前军万马：还记得郭靖和杨过吗？武林高手与前军万马：还记得郭靖和杨过吗？误区误区4 4：代码规范只是规定如何编写代码：代码规范只是规定如何编写代码代码规范包括编写代码、维护代码和管理代码代码规范包括编写代码、维护代码和管理代码代码思想良好的文字作品代码思想良好的文字作品

6、3/3/2022编辑ppt7内容提要内容提要代码管理的作用和内容代码管理的作用和内容代码编写与调试的规范代码编写与调试的规范代码控制与管理的规范代码控制与管理的规范3/3/2022编辑ppt8代码编写规范的内容代码编写规范的内容命名规范命名规范如何定义代码文件名与模块名如何定义代码文件名与模块名如何定义变量与数据结构名称如何定义变量与数据结构名称如何定义函数名与接口名称如何定义函数名与接口名称语句编写规范语句编写规范TabTab、空格、括号的使用、空格、括号的使用语句排列与空行语句排列与空行代码注释规范代码注释规范文件头注释与函数头注释文件头注释与函数头注释函数内部注释函数内部注释3/3/20

7、22编辑ppt9案例分析案例分析代码编写规范示例代码编写规范示例代码片断示例代码片断示例分析和总结分析和总结良好的代码规范是团队精神和职业素养的体现良好的代码规范是团队精神和职业素养的体现习惯的培养是保证团队成功的关键习惯的培养是保证团队成功的关键3/3/2022编辑ppt10代码编写的工程习惯代码编写的工程习惯习惯习惯1 1：使用空格和空行，增进易读性：使用空格和空行，增进易读性习惯习惯2 2：注重多重嵌套语句的起止注释：注重多重嵌套语句的起止注释习惯习惯3 3：避免使用过于复杂、难懂的算法：避免使用过于复杂、难懂的算法习惯习惯4 4：尽可能不要使用递归：尽可能不要使用递归3/3/2022编

8、辑ppt11代码调试规范的内容代码调试规范的内容如何尽可能的减少出错概率？如何尽可能的减少出错概率？增加对数据合法性的检查增加对数据合法性的检查增加对各类异常的处理增加对各类异常的处理增加关键处理步骤的调试输出增加关键处理步骤的调试输出代码调试规范代码调试规范出错控制机制的设计：出错控制机制的设计：Error CodeError Code如何定义如何定义调试输出机制的设计：如何调试输出机制的设计：如何OutputOutput、ReturnReturn调试代码的编写规范调试代码的编写规范3/3/2022编辑ppt12如何减少出错概率如何减少出错概率示例示例1 1：计算窗口的宽高比：计算窗口的宽高

9、比usWHRatio = usWeight / usHeight;usWHRatio = usWeight / usHeight;可能出错的机会：除零错可能出错的机会：除零错如何保证出错概率少？如何保证出错概率少？示例示例2 2：如何处理各类可能的异常：如何处理各类可能的异常返回值控制：返回值控制：Error Code Error Code C+C+中的中的CatchTryCatchTry应用应用应用界面中的消息框应用界面中的消息框3/3/2022编辑ppt13代码调试规范代码调试规范如何设计如何设计Error Code Error Code Error CodeError Code的定义规则

10、的定义规则Error CodeError Code的使用规则的使用规则Error CodeError Code的分析规则的分析规则如何添加调试代码和调试输出如何添加调试代码和调试输出预编译宏定义的使用：代码运行的开关预编译宏定义的使用：代码运行的开关调试输出的设计：文件输出和界面输出调试输出的设计：文件输出和界面输出调试代码运行控制：调试代码运行控制：DebugDebug版和版和ReleaseRelease版版3/3/2022编辑ppt14内容提要内容提要代码管理的作用和内容代码管理的作用和内容代码编写与调试的规范代码编写与调试的规范代码控制与管理的规范代码控制与管理的规范3/3/2022编辑

11、ppt15代码控制的规范代码控制的规范软件开发的分工软件开发的分工 每一个模块、文件均指定固定人员每一个模块、文件均指定固定人员首要的工作是确定接口首要的工作是确定接口次要的工作是确定数据结构和相关常量定义次要的工作是确定数据结构和相关常量定义代码权限的控制代码权限的控制应用应用VSSVSS建立代码管理环境建立代码管理环境针对针对ProjectProject分配合理的权限分配合理的权限保证每个人规范的使用保证每个人规范的使用Check in/Check outCheck in/Check out3/3/2022编辑ppt16代码控制的常见错误代码控制的常见错误重复分工的危害重复分工的危害 多人

12、同时写一个文件或一个函数造成冲突多人同时写一个文件或一个函数造成冲突多人多人Check in/Check out Check in/Check out 造成代码丢失造成代码丢失资源的重复投入和浪费资源的重复投入和浪费不注重权限和版本的危害不注重权限和版本的危害无法重复、永远丢失的代码无法重复、永远丢失的代码无法跟踪、无法重现的错误无法跟踪、无法重现的错误无法控制、无法管理的团队无法控制、无法管理的团队3/3/2022编辑ppt17案例剖析案例剖析代码管理示范代码管理示范VSSVSS的架构示例的架构示例 建立目录结构、增加管理文件建立目录结构、增加管理文件分配权限、添加版本控制分配权限、添加版本控制VSSVSS的应用示例的应用示例如何如何Check