开发文档-编程规范

《开发文档-编程规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java编码规范________________________________________________编码规范________________________________________________Java编码规范修订历史记录文档标识LENOVO-JAVA-1_0.doc页数文档名称JAVA编码规范序号修改描述版本号日期作者1创建文档1.02010/04/01胡少华Java编码规范1.应用范围32.设计类和方法32.1创建具有很强内聚力的类32.2创建松散连接和高度专用的方法32.

2、3编程原则43.命名约定53.1包、类及方法命名53.2其它64.使用常量64.1使用常量65.变量75.1定义有焦点的变量75.2只对常用变量名和长变量名进行缩写75.3使用统一的量词75.4使用肯定形式的布尔变量75.5为每个变量选择最佳的数据类型75.6尽量缩小变量的作用域86.代码的格式化86.1对代码进行格式化时，要达到的目的86.2编程原则87.代码的注释97.1使用代码注释的目的97.2编程原则97.3注释哪些部分117.4示例117.4.1块注释：117.4.2行注释：127.4.3

3、尾随注释：127.4.4行尾注释：127.4.5文档注释：12Java编码规范8.表达式和语句128.1每行应该只有一条语句。128.2if-else,if-elseif语句，任何情况下，都应该有“{”，“}”，格式如下：128.3for语句格式如下：138.4while语句格式如下：138.5do-while语句格式如下：138.6switch语句，每个switch里都应包含default子语句,格式如下：138.7try-catch语句格式如下：139.错误处理和异常事件1410.封装、事务14

4、11.可移植性14Java编码规范1.应用范围本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）均应遵守这个规范。2.设计类和方法2.1创建具有很强内聚力的类方法的重要性往往比类的重要性更容易理解，方法是指执行一个统一函数的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工

5、程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。类应该用来将相关的方法组织在一起。当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。创建类时，应知道“模块化”这个术

6、语的含义是什么。类的基本目的是创建相当独立的程序单元。2.2创建松散连接和高度专用的方法1.使所有方法都执行专门的任务每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。创建专用方法有许多好处。首先调试将变得更加容易。2.尽量使方法成为自成一体的独立方法当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法会使调试和修改变得比较困难，因为它牵涉到更多的因素。松散连接的方法优于紧密连接的方法，但你不可能使每个方法都成为独立的方法。若要使方法

7、具备较强的独立性，方法之一是尽量减少类变量。创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该方法的内部工作情况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠全局变量的原因。创建专用方法时，请考虑下列指导原则：1）将复杂进程放入专用方法。如果应用程序使用复杂的数学公式，请考虑将每个公式放入它自己的方法中。这样使用这些公式的其他方法就不包含用于该公式的实际代码。这样也可以更容易发现与公式相关的问题。Java编码规范1）将数据输入/输出（I/O）放入专用方法

8、。2）将专用方法中可能要修改的代码隔离。如果你知道某个进程经常变更，请将这个多变的代码放入专用方法，以便以后可以更容易的进行修改，并减少无意中给其他进程带来问题的可能性。3）将业务规则封装在专用方法中。业务规则常属于要修改的代码类别，应与应用程序的其余部分隔开。其他方法不应知道业务规则，只有要调用的方法才使用这些规则。1.设计类和方法时，要达到下列目的：1）创建更加容易调试和维护的方法2）创建具有强大内聚力的类3）创建高度专用的方法4）创建松散连接的方法5）尽量使方法