文档介绍:Java 语言编码规范(Java
Code Conventions)
目录
介绍(Introduction) 4
为什么要有编码规范(Why Have Code Conventions) 4
版权声明(Ackno人员必须一致遵守编码规范。
版权声明(Acknowledgments)
本文档反映的是 Sun MicroSystems 公司,Java 语言规范中的编码标准部分。主要贡献者包括:Peter King,Patrick Naughton,Mike DeMoney,Jonni Kanerva, Kathy Walrath以及 Scott Hommel。
本文档现由 Scott Hommel 维护,有关评论意见请发至 ******@
文件名(File Names)
这部分列出了常用的文件名及其后缀。
文件后缀(File Suffixes)
Java 程序使用下列文件后缀:
文件类别
Java 源文件
文件后缀
.java
Java 字节码文件 .class
常用文件名(Common File Names) 常用的文件名包括:
文件名
用途
GNUmakefile makefiles 的首选文件名。我们采用 gnumake 来创建(build)软
README
件。
概述特定目录下所含内容的文件的首选文件名
文件组织(File Organization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过 2000 行的程序难以阅读,应该尽量避免。"Java 源文件范例"提供了一个布局合理的 Java 程序范例。
Java 源文件(Java Source Files)
每个 Java 源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联,可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
Java 源文件还遵循以下规则:
开头注释(参见"开头注释")
包和引入语句(参见"包和引入语句")
类和接口声明(参见"类和接口声明")
开头注释(Beginning Comments)
所有的源文件都应该在开头有一个 C 语言风格的注释,其中列出类名、版本信息、日期和版权声明:
/*
Classname
*
Version information
*
Date
*
Copyright notice
*/
包和引入语句(Package and Import Statements)
在多数 Java 源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。例如:
package ;
import ;
类和接口声明(Class and Interface Declarations)
下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java 源文件范例"中一个包含注释的例子。
类/ 接口声明的各部分
类 / 接 口 文 档 注 释
(/**……*/)
类或接口的声明
类/ 接口实现的注释
3 (/*……*/)如果有必要的话
类的(静态)变量
实例变量
构造器
方法
注解
该注释中所需包含的信息,参见"文档注释"
该注释应包含任何有关整个类或接口的信息,而这些信息又不适合作为类/接口文档注释。
首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。
首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。
这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。
缩进排版(Indentation)
4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格vs. 制表符)。一个制表符等于 8 个空格(而非 4 个)。
行长度(Line Length)
尽量避免一行的长度超过 80 个字符,因为很多终端和工具不能很好处理之。注意:用于文档中的例子应该使用更短的行长,长度一般不超过70 个字符。
换行(Wrapping Lines)
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:
在一个逗号后面断开
在一个操作符前面断开
宁可选择较高级别(higher-