《Java 程序编码规范》.pdf

附录 A Java 程序编码规范 开发程序时，往往会有很多人参与，为了使程序的结构与代码风格标准化，以便于使每个参与开发的 人员尽可能直观地查看和理解其他人编写的代码，需要在编码之前制定一套统一的编码规范。下面介绍一 套Java 语言中常用的程序编码规范供读者参考。 A.1 命 名 规 则 A.1.1 数据类型简写规则 程序中定义常量、变量或方法等内容时，常常需要指定类型。下面介绍常见的数据类型简写规则，如 附表A.1 所示。 附表A.1 数据类型简写规则 数 据 类 型 简 写 数 据 类 型 简 写 整型 int 长整型 lint 字符串 str 单精度浮点型 flt 布尔型 bl 双精度浮点型 dbl 短整型 sint 字节型 bt A.1.2 变量及常量名称命名规则 根据不同的程序需要，编写代码时都需要定义一定的变量或常量。下面介绍一种常见的变量及常量命 名规则。  变量：Java 中变量由单个或多个单词组成，其中单个单词或多个单词的第一个单词所有字母小写， 其余单词首字母大写，并且不能使用Java 中的关键字，如userName 。变量的名称要有意义，能从 变量名称中理解其含义。  常量：是在程序运行过程中值不能被改变的量。常量也要使用有意义的名称，并且单词的所有字 母要大写，如果由多个单词组成，就使用下划线分割，如USER_NAME 。 A.1.3 类命名规则  使用完整的单词，避免使用缩写。  类名称的首字母要大写。  尽量使用名词。类通常表示一种对象类型，而对象一般使用具有名词性质的名称。  不要使用“$”或下划线作为前缀。尽管在Visual Basic 和Visual C++等其他语言中，这是非常普遍 学通Java Web 的24 堂课 的，但在Java 语言中不提倡使用。  自定义异常类命名通常以Exception 结尾，但应该尽量避免自定义异常类。  避免将多个类放在一个文件中。  初始化类的实例时，除非十分必要，否则不要赋值为null 。 A.1.4 成员变量命名规则  成员变量名称通常都是名词，命名规则与变量相同，如name 和age 等。  成员变量名称不能与Java 关键字相同。  尽量不要提供public 和protected 的成员变量，使用设置器与访问器操作它们。 A.1.5 方法命名规则  方法名通常是动词，因为方法用来实现一个对象的行为功能，如read() 、write() 、start()和stop()等。  当重载方法时，参数的顺序和声明时的参数顺序要一致。  定义方法名时不要使用缩写。如果认为应用程序中的某些项目应使用缩写，那么请将这些情况加 上注释，并确保每个人在所有时间内都使用这些缩写，一定不要在某些方法中对某些单词进行缩 写，而在别的方法中却不使用缩写。  一个方法的代码长度最好不要超过25 行。  避免方法中有超过 5 个参数的情况，如果超过了，则应使用自定义类（即 JavaBean ）来传递多个 参数。 A.1.6 接口命名规则  接口名称的首字母要大写。  接口名称尽量具有描述性，并使用形容词，因为接口常常用于给一个类添加某种能力，如Runnable 。  避免一个接口中只有一个成员，尽量使每个接口中包含3～5 个成员。  接口中的成员不应该超过20 个。  尽量少使用匿名接口实现。