Java 编码规范
翻译:王士勇
(转载请保留作者,谢谢)
1. 引言
1.1 为什么要编码规范
编码规范为什么是重要的?有以下一些理由:
l 一份软件80%的生命周期是维护期
l 任何软件都很难说他的整个生命周期都是由他的原始作者来维护
l 编码规范改善软件的可读性,使得软件工程师充分理解新的代码变得非常的快速。
l 如果你要把你的原码作为产品发布,你需要确保他像你的其他产品一样干净并且封装的好。
为了按照规范工作,每个人写软件的时候,都必须遵守编码规范。记住,是每个人!
1.2 致谢
这本书是反映的是Java Language Specification 中关于java语言编码规范的。在这里要着重对Peter king ,Patrick Naughton,Mike DeMoney,Jonni Kanerva,Kathy Walrath,和Scott Hommel表示感谢。
2. 文件名
这一节列出了本书所用的大部分文件名和后缀。
2.1 文件后缀
.java java 源文件后缀
.class java 字节码文件后缀
2.2 常用的文件名
经常使用的文件名包括以下:
GNUmakefile 首选的makefile的名字,我们使用gnumake来build我们的软件。
README 那些专门概述特定文件夹内容的文件的首选的名字
3. 文件的组织
一个文件的各个部分之间应该用空行隔开,并且应该用一个可选的注解来标示每个不同的部分。
文件超过2000行,是非常笨重讨厌(cumbersome)的,应该避免。
至于java 编程的正确格式的示例,请参看18页上的”JAVA Source File Example(Java 原码文件示例)”。
3.1 Java 源码文件
每一个Java源码文件都包括一个唯一的public 类或interface。当私有的类和interface 都和这个public 类有关联时,你可以把它们放到这个public 类的源文件中。这个public 类或interface 应当是这个文件的第一个类或interface 。
Java 源文件有以下的顺序:
l 文件开头注解(参见第二页的“Beginning Comments(开头注解)”)
l 声明package 的语句和载入语句。
l 类和interface的声明(参见page 3的“Class and Interface Declarations”)
3.3.1 开头注解
所有的源文件都应该以一个C语言风格的注解开头。这个注解应该列出类名,版本信息,日期和版权声明:
/*
*Classname
*
*Version information
*
* Date
*
* copyright notice
*
*/
3.1.2 声明包的语句和import 语句
绝大多数java 源文件中的第一非注释行应该是声明包的语句。此后,紧接着是import 语句。例如:
package java.awt;
import java.awt.peer.CanvasPeer;
3.1.3 类和接口的声明
下面的表格描述了部分的类和接口的声明,他们应该按照表格的顺序。参看“Java Source File Example” on page 18 。