Java语言开发规范.docVIP

目录 1 目的 5 2 命名规范 5 2.1 包(Package)的命名 5 2.2 类(Class)的命名 5 2.3 对象(类实例)Object命名 5 2.4 基本数据类型(Primitive)的变量命名 6 2.5 常量(Constants)的命名 6 2.6 参数(Parameter)的命名 6 2.7 数组(Array)的命名 6 2.8 方法(Method)的命名 6 3 Java文件样式 6 3.1 版权信息格式 6 3.2 package/import格式 7 3.3 类方法注释的格式 8 3.4 实现注释的格式 8 3.5 未完成(ToDO)的格式 10 4 代码风格(Code Style) 10 目的 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码为了执行规范，每个软件开发人员必须遵守编码规范。 命名规范 命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码ackage的名字必须都是由小写单词组成的。 尽可能使用有英语意义的包名，禁止使用汉语拼音。 避免过长的包名和过深的包层次结构。尽可能使用国际上通过的一些缩写形式，不要自创。如util、dao、dto、form、action、handler、impl、proxy、tag、test等。一个包的范例图： 类(Class)的命名 类名是个名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或开头，尽管这在语法上是允许的。除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 数据类型 数据类型标识 数据类型 数据类型标识 整型(int) i 浮点型(float) f 双精型(double) d 字符型(char) c 长整型(long) l 布尔型(boolean) b 常量(Constants)的命名 tatic final变量的名字应该都大写,并且指出完整含义，单词间用下划线隔开static final int MIN_WIDTH = 4;static final int MAX_WIDTH = 999;static final int GET_THE_CPU = 1; 参数(Parameter)的命名 参数的命名约定参见2.3和2.4。 数组(Array)的命名 数组应该总是用下面的方式来命名: byte[] aBuffer; 而不是:byte aBuffer[]。 方法(Method)的命名 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。doSaveToAtm(); startBackendProcess(); Java文件样式 所有的Java(*.java)文件都必须遵守如下的样式规则: 版权信息格式 版权信息必须在 java 文件的开头,但在package和import段落之后。比如: package com.fsti.kdsl.core.action; import java.util.ArrayList; /** * pTitle:历时计算模块之基本统计类 /p * pDescription: 使用递归算法实现/p * pCopyright: Copyright (c) 2004/p * pCompany: FSTI Co.,LTD/p * @author Li Lin * @version 2.0 * @since 1.1 */ javadoc 的信息（如修改信息）也可以包含在这里。尽可能使用开发工具JBuilder生成。 package/import格式 package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。我们约定不可以出现java.util.*之类的不明确的声明。如： package com.fsti.duration.controller ; import java.util.GregorianCalendar ; import java.util.Set ; import com.fsti.duration.config.DurationConfig ; import com.fsti.duration.constant.StateConstant ; import com.fst