公司开发编程规范.doc

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

1、开发编程规范江苏方天电力技术有限公司2009.6文档修订记录日期版本描述作者目录1绪论11.1目的11.2参考资料11.3概述12Java编程规范22.1代码组织与风格22.2注释52.3命名102.4声明162.5类与接口202.6方法242.7表达式与语句252.8错误与异常282.9测试与Bug跟踪292.10性能与安全312.11附录333页面开发编程规范353.1页面规范353.2命名规范463.3jsp、html文件规范473.4js文件规范514Webwork和Spring配置文件描述符规范534.1xwork配置详述535数据库设计规范585.2数

2、据库部署模式696页面规范CSS实例701绪论1.1目的本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。1.2参考资料《江苏省电力公司信息建设非功能需求规范》《SunJava语言编码规范》(JavaCodeConventions)1.3概述对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功

3、能等。然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。本规范参考自业界标准编程规范、江苏电力非功能需求并结合公司相关项目的编程经验、习惯等而制定。2Java编程规范2.1代码组织与风格2.1.1基本原则代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。本章所涉及到的内容一般都可在Java集成编辑环境中进行相应设置，

4、也可由Ant等调用checkstyle等来进行自动规整。1.1.1缩进子功能块当在其父功能块后缩进。当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。代码中以TAB（4个字符）缩进，在编辑器中请将TAB设置为以空格替代，否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式。例如：Table1．缩进示例publicvoidmethodName(){if(somecondition){for(…){//somesentences}//endfor}//endif}1.1.2长度为便于阅读和理解，单个函数的有效代码长度当尽量控制在100行以内（

5、不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。1.1.1行宽页宽应该设置为80字符。一般不要超过这个宽度,这会导致在某些机器中无法以一屏来完整显示,但这一设置也可以灵活调整。在任何情况下,超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后,应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。1.1.2间隔类、方法及功能块

6、间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附录的代码示例1.1.3对齐关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。连续赋值时当对齐操作符。当方法参数过多时当在每个参数后（逗号后）换行并对齐。当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。变量定义最好通过添加空格形成对齐，同一类型的变量应放在一起。如下例所示：Table2．对齐示例//变量对齐----------------------------------

7、-------------intcount=100;intlength=0;StringstrUserName=null;Integer[]porductCode=newInteger(2);//产品编码数组//参数对齐----------------------------------------------publicConnectiongetConnection(Stringurl,StringuserName,Stringpassword)throwsSQLException,IOException{}//换行对齐---------------------

8、-----