JAVA开发规范整理版.pdfVIP

Java 开发规范 第 1 章 绪论 1.1 目的 本规范的目的是使本组织能以标准的、 规范的方式设计和编码。 通过建立编码规范， 以 使每个开发人员养成良好的编码风格和习惯； 并以此形成开发小组编码约定， 提高程序的可 靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质 量。 1.2 范围 本规范适用于本公司下所有软件项目、产品等的设计、开发以及维护、升级 等。本规 范使用于本公司的所有软件开发人员，在整个软件开发过程中必须遵循此规范。 1.3 概述 对于代码， 首要要求是它必须正确， 能够按照设计预定功能去运行； 第二是要求代码必 须清晰易懂， 使自己和其他的程序员能够很容易地理解代码所执行的功能等。 然而， 在实际 开发中，每个程序员所写的代码却经常自成一套， 很少统一， 导致理解困难，影响团队的开 发效率及系统的质量等。 因此， 一份完整并被严格执行的开发规范是非常必须的， 特别是对 软件公司的开发团队而言。 最根本的原则：代码虽然是给机器运行的，但却是给人读的！ 第 2 章 代码组织与风格 2.1 基本原则 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯 和编辑器等可以设置和形成自己的风格， 但必须前后一致， 并符合本规范的基本要求和原则。 本章所涉及到的内容一般都可在 Java 集成编辑环境中进行相应设置。 2.2 缩进 子功能块当在其父功能块后缩进。 当功能块过多而导致缩进过深时当将子功能块提取 出来作为子函数。 代码中以 TAB （4 个字符）缩进。 2.3 长度 为便于阅读和理解，单个函数的有效代码长度当尽量控制在 100 行以内（不包括注释 行），当一个功能模块过大时往往造成阅读困难， 因此当使用子函数等将相应功能抽取出来， 这也有利于提高代码的重用度。 单个类也不宜过大， 当出现此类情况时当将相应功能 =- 的代码重构到其他类中， 通过组 合等方式来调用，建议单个类的长度包括注释行不超过 1500 行。 尽量避免使用大类和长方法。 2.4 行宽 页宽应该设置为 80 字符。 一般不要超过这个宽度 , 这会导致在某些机器中无法以一屏 来完整显示 , 但这一设置也可以灵活调整。在任何情况下 , 超长的语句应该在一个逗号后或 一个操作符前折行。 一条语句折行后 , 应该比原来的语句再缩进一个 TAB 或 4 个空格， 以 便于阅读。 在书写 SQL 时，最好先在 PL/SQL 中先把语句写好，然后调用 PL/SQL 语句美化器进 行美化。这个功能在 PL/SQL6.0 及以后版本中才提供。具体位置为： Edit 菜单 PL/SQL beautifier 菜单。 行宽在 WORKSHOP 中的设置方法为： windows 菜单 Preferences 菜单 JAVA code style formatter ，选择一个格式文件，点击“ SHOW ”按钮，修改红色框中的地方的值即可。 2.5 间隔 类、方法及功能块间等应以空行相隔，