软件开发编程规范Martin.docVIP

软件设计 编 程 规 范 Ver 0.1 XXX科技有限公司 2007年9月 目 录 版本记录 3 版权说明 4 第一章 格式与排版 5 1.1 空行 5 1.2 代码行 5 1.3 代码行内的空格 6 1.4 对齐 7 1.5 长行拆分 8 1.6 修饰符的位置 9 1.7 注释 9 1.8 类的版式 10 第二章 命名规则 12 2.1 共性规则 12 2.2 简单的Windows应用程序命名规则 13 2.3 VC应用程序命名范例 14 第三章 常量 16 3.1 为什么需要常量 16 3.2 const 与 #define的比较 16 3.3 常量定义规则 16 3.4 类中的常量 16 第四章 表达式和基本语句 18 4.1 运算符的优先级 18 4.2 复合表达式 18 4.3 if 语句 19 4.4 循环语句的效率 21 4.5 for 语句的循环控制变量 21 4.6 switch语句 22 4.7 goto语句 22 第五章 函数设计 24 5.1 参数的规则 24 5.2 返回值的规则 25 5.3 函数内部实现的规则 27 5.4 其它建议 28 5.5 使用断言 28 5.6 引用与指针的比较 29 5.6 函数编写范例 31 第六章 使用SourceSafe进行版本管理 32 1．SourceSafe的原理 32 2．VSS中的几个重要概念 32 3．VSS 环境配置 33 4．VSS的使用 35 版本记录 版本/状态 编写整理 完成日期 备注 V 0.1 草稿文件 邱益农 2007年9月25日 版权说明 开发规范就是经验的积累，本来没有什么版权可言，因为随着开发时间的增多，大家都可以总结出类似的东西出来，但是后来者总会慢慢参考前人的经验，为了尊重前人的劳动成果，故把本规范的制定过程说明一下。 针对本公司软件开发的具体特点，以嵌入式开发为主，越来越多的使用了C语言，因此我考虑以C++/C语言为基础，收集汇总一份比较适合公司内部开发使用的编程规范。本来，林锐博士的《高质量C++/C编程指南》一文对编码规范说的比较详细了，而且也得到了很多开发人员的认可。本人也认为该文很有价值，文采不错，所以也不敢乱加篡改，只是选择了其中几章，稍微调整了一下排版顺序，又加上自己总结的一点开发经验。 软件开发离不开团队合作，为了加强开发人员的合作，也是为了方便大家进行版本管理，防止误操作对源码的损害，在最后一章编写了“使用SourceSafe进行版本管理”，简要介绍了SourceSafe的实用操作，希望能对大家有一定的帮助。 可能有的同事看到本规范有厚厚的三四十页，感觉会很厌烦，是的，是比较多，因为本规范是面向所有水平的开发人员。如果你已经拥有很好的开发风格的话，就不需要从头到尾仔细研读了，大体浏览一下，多提点意见就是了。如果你需要而且想改进开发风格的话，本规范确实是一个比较好的基础参考资料，当你掌握了本规范后，就可以在此基础上去总结更好的规范了。 欢迎本部门和公司其他部门的同事对本规范提出批评建议。 邱益农 2007.9.25 第一章 格式与排版 源码的排列方式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。 1.1 空行 空行起着分隔程序段落的作用。空行得体（不过多也过少）将使程序的布局更加清晰，空行不会浪费内存。 【规则1-1-1】在每个类声明之后和定义结束之后都要加空行。参见示例3-1（a） 【规则1-1-2】在一个函数体内，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例3-1（b ） // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } 示例1-1(a) 函数之间的空行 示例1-1(b) 函数内部的空行 1.2 代码行 【规则1-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 【规则1-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 示例3-2（a）为风格良好的代码行，示例3-2（b）为风格不良的代码