JAVA开发规范整理版

《JAVA开发规范整理版》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Java开发规范第1章绪论1.1目的本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。1.2范围本规范适用于本公司下所有软件项目、产品等的设计、开发以及维护、升级等。本规范使用于本公司的所有软件开发人员，在整个软件开发过程中必须遵循此规范。1.3概述对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所

2、执行的功能等。然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。最根本的原则：代码虽然是给机器运行的，但却是给人读的！第2章代码组织与风格2.1基本原则代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。本章所涉及到的内容一般都可在Java集成编辑环境中进行相应设置。2.2缩进子功能块当在其父功能块后缩进。当功能块过多

3、而导致缩进过深时当将子功能块提取出来作为子函数。代码中以TAB（4个字符）缩进。2.3长度为便于阅读和理解，单个函数的有效代码长度当尽量控制在100行以内（不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。单个类也不宜过大，当出现此类情况时当将相应功能=-的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。2.4行宽页宽应该设置为80字符。一般不要超过这个宽度,这会导致在某些机器中无法以一屏来完整显示,但这一设置也可以灵活调整。在任何

4、情况下,超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后,应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。在书写SQL时，最好先在PL/SQL中先把语句写好，然后调用PL/SQL语句美化器进行美化。这个功能在PL/SQL6.0及以后版本中才提供。具体位置为：Edit菜单àPL/SQLbeautifier菜单。行宽在WORKSHOP中的设置方法为：windows菜单àPreferences菜单àJAVAàcodestyleàformatter，选择一个格式文件，点击“SHOW”按钮，修改红色框中的地方的值即可。2.5间隔类、方法及功能块间等应以空

5、行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。相应独立的功能模块之间可使用注释行间隔，并标明相应内容。设置方法：windows菜单àPreferences菜单àJAVAàcodestyleàformatter，选择一个格式文件，点击“SHOW”按钮，修改红色框中的两个页面中的值即可。2.6对齐关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。连续赋值时当对齐操作符。当方法参数过多时当在每个参数后（逗号后）换行并对齐。当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。变量定义最好通过添加空格形成

6、对齐，同一类型的变量应放在一起。设置方法：windows菜单àPreferences菜单àJAVAàcodestyleàformatter，选择一个格式文件，点击“SHOW”按钮。修改各变量的对齐在红色框中的地方。参数过长时对齐设置在：2.7括号{}中的语句应该单独作为一行，左括号"{"当紧跟其语句后，右括号"}"永远单独作为一行且与其匹配行对齐。不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。左括号是否换行等随个人习惯而定，若换行则当与其前导语句首字符对齐。设置方法：windows菜单àPreferences菜单àJAVAàco

7、destyleàformatter，选择一个格式文件，点击“SHOW”按钮。红色框中的TAB页可设置括号的对齐。第3章注释3.1基本原则Ø注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员理解。Ø如果你的程序不值得注释，那么它很可能也不值得运行。Ø避免使用装饰性内容。Ø保持注释的简洁。Ø注释信息不仅要包括代码的功能，还应给出原因。Ø不要为注释而注释。Ø除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。Ø对类、方法、变量等的注释需要符合JavaDoc规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML标记

8、格式化注释