软件开发编程规范Martin.doc

《软件开发编程规范Martin.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件设计编程规范Ver0.1XXX科技有限公司2007年9月目录版本记录3版权说明4第一章格式与排版51.1空行51.2代码行51.3代码行内的空格61.4对齐71.5长行拆分81.6修饰符的位置91.7注释91.8类的版式10第二章命名规则122.1共性规则122.2简单的Windows应用程序命名规则132.3VC应用程序命名范例14第三章常量163.1为什么需要常量163.2const与#define的比较163.3常量定义规则163.4类中的常量16第四章表达式和基本语句184.1运算符的优先级184.2复合表达式184.3if语句194.4循环语句的效率214.

2、5for语句的循环控制变量214.6switch语句224.7goto语句22第五章函数设计245.1参数的规则245.2返回值的规则255.3函数内部实现的规则275.4其它建议285.5使用断言285.6引用与指针的比较295.6函数编写范例31第六章使用SourceSafe进行版本管理321．SourceSafe的原理322．VSS中的几个重要概念323．VSS环境配置334．VSS的使用35版本记录版本/状态编写整理完成日期备注V0.1草稿文件邱益农2007年9月25日版权说明开发规范就是经验的积累，本来没有什么版权可言，因为随着开发时间的增多，大家都可以总结出类

3、似的东西出来，但是后来者总会慢慢参考前人的经验，为了尊重前人的劳动成果，故把本规范的制定过程说明一下。针对本公司软件开发的具体特点，以嵌入式开发为主，越来越多的使用了C语言，因此我考虑以C++/C语言为基础，收集汇总一份比较适合公司内部开发使用的编程规范。本来，林锐博士的《高质量C++/C编程指南》一文对编码规范说的比较详细了，而且也得到了很多开发人员的认可。本人也认为该文很有价值，文采不错，所以也不敢乱加篡改，只是选择了其中几章，稍微调整了一下排版顺序，又加上自己总结的一点开发经验。软件开发离不开团队合作，为了加强开发人员的合作，也是为了方便大家进行版本管理，防止误操作

4、对源码的损害，在最后一章编写了“使用SourceSafe进行版本管理”，简要介绍了SourceSafe的实用操作，希望能对大家有一定的帮助。可能有的同事看到本规范有厚厚的三四十页，感觉会很厌烦，是的，是比较多，因为本规范是面向所有水平的开发人员。如果你已经拥有很好的开发风格的话，就不需要从头到尾仔细研读了，大体浏览一下，多提点意见就是了。如果你需要而且想改进开发风格的话，本规范确实是一个比较好的基础参考资料，当你掌握了本规范后，就可以在此基础上去总结更好的规范了。欢迎本部门和公司其他部门的同事对本规范提出批评建议。邱益农2007.9.25第一章格式与排版源码的排列方式虽然

5、不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。1.1空行空行起着分隔程序段落的作用。空行得体（不过多也过少）将使程序的布局更加清晰，空行不会浪费内存。l【规则1-1-1】在每个类声明之后和定义结束之后都要加空行。参见示例3-1（a）l【规则1-1-2】在一个函数体内，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例3-1（b）//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行voidFunction3(…){…}//空行while(condition){statem

6、ent1;//空行if(condition){statement2;}else{statement3;}//空行statement4;}示例1-1(a)函数之间的空行示例1-1(b)函数内部的空行1.2代码行l【规则1-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。l【规则1-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。示例3-2（a）为风格良好的代码行，示例3-2（b）为风格不良的代码行。intwidth;//宽度intwidth,

7、height,depth;//宽度高度深度intheight;//高度intdepth;//深度x=a+b;y=c+d;z=e+f;X＝a+b;y=c+d;z=e+f;if(width