[精品]软件编码规范设计.doc

《[精品]软件编码规范设计.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、.软件编码规范文件状态：[√]草稿[]正式发布[]正在修改文件编号：RDC-DED-SCS-SPC-00当前版本：作者：审核人：完成日期：中国人民银行清算总中心支付系统开发中心文档修订记录.版本编号变化状态简要说明日期变更人批准日期批准人注：变化状态：A—增加，M—修改，D—删除.目录第一篇C/C++编码规范6第一章代码组织6第二章命名92.1文件命名92.2变量命名92.3常量与宏命名102.4类命名102.5函数命名102.6参数命名11第三章注释123.1文档化注释123.2语句块注释173.3代码维护注释20第四章编码风格

2、224.1排版风格224.2头文件264.3宏定义274.4变量与常量304.5条件判断324.6空间申请与释放334.7函数编写334.8类的编写374.9异常处理404.10特殊限制40第五章编译41第六章ESQL/C编码46第二篇JAVA编码规范47第一章代码组织48第二章命名512.1包命名512.2类命名512.3接口命名512.4方法命名512.5变量命名512.6类变量命名522.7常量命名522.8参数命名52第三章注释533.1文档化注释533.2语句块注释573.3代码维护注释59第四章编码风格614.1排版风

3、格614.2包与类引用664.3变量与常量664.4类编写674.5方法编写684.6异常处理714.7特殊限制71.第五章编译73第六章JSP编码746.1文件命名及存放位置746.2内容组织746.3编码风格766.4注释786.5缩进与对齐786.6表达式796.7JavaScript79第三篇POWERBUILDER编码规范80第一章代码组织81第二章命名822.1文件命名822.2对象命名822.3变量命名842.4常量命名852.5函数与事件命名852.6参数命名85第三章注释853.1文档化注释853.2语句块注释8

4、83.3代码维护注释88第四章编码风格894.1界面风格894.2排版风格934.3变量与常量954.4条件判断964.5空间申请与释放974.6函数编写974.7特殊限制97第五章SQL编码98.前言程序编码是一种艺术，既灵活又严谨，充满了创造性与奇思妙想。然而应用软件设计是一项团结协作工程，而非程序员展示个人艺术的舞台，大型应用软件项目更是由很多程序员组成的大型开发团队协同完成的。每个程序员都有自己的编码经验与风格，如果缺乏统一的编程规范，则可能导致软件产品最终程序代码风格迥异，可读性与可维护性均较差，不仅给程序代码的理解带来

5、障碍，也增加维护阶段的工作量。此外，经验证明不规范的编码行为往往还会导致程序出现更多的隐含错误。为规范编码行为，增强程序代码的可读性、可维护性，提高编码质量与效率，保障应用软件产品整体品质与可持续开发性，特制定本规范。本规范分C/C++编码规范、Java编码规范、PB编码规范三篇，分别从代码组织、命名、注释、编码风格、编译等方面加以阐述。规范文本分为规则与建议两种，其中规则是强制执行的条款，建议则由程序员根据实际情况灵活掌握。.第一篇C/C++编码规范第一章代码组织规则1:使用不同的文件分别放置模块的约束与实现。C++程序的约束文

6、件使用.hpp做扩展名，实现文件使用.cpp做扩展名；C程序的约束文件使用.h做扩展名，实现文件使用.c做扩展名。规则2:一个模块可以包含一个类或功能上紧密联系的多个类。禁止将功能关联松散的多个类，放置到一个模块中。规则3:模块约束应仅包含模块对外提供的功能，禁止将模块内部使用的功能声明在模块约束中。下例中IsChineseChar()是内部使用的函数，不提供给外部应用使用，因此不能在commpub.hpp中增加声明。例：commpub.hppBOOLIsChineseString(constchar*sInStr);例：comm

7、pub.cppstaticBOOLIsChineseChar(constchar*s){……;}BOOLIsChineseString(constchar*sInStr){for(intii=0;ii

8、el/bin目录，静态库或动态库放置到rel/lib目录（应用使用的外部库及头文件放置在rel同级的lib与lib/include目录）。.规则1:复杂应用应分子系统创建目录结构，模块程序代码应分别放置到src/module/include目录与s