《JAVA代码规范》（二）通用代码格式 - 文件组织(2.1)

转自：http://www.javadt.com/thread-353-1-1.html

《JAVA代码规范》（二）通用代码格式 - 文件组织(2.1)

 

2       通用代码格式

2.1      文件组织

一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。

Java源文件必须遵循以下规则：

Ø        文件头部注释

所有的源文件都应该在开头有一个C语言风格的注释，其中列出文件名、作者、公司、日期、描述、修改说明和版权声明：

/*

* File:    OrderSessionBean.java

* Author:  ajava.org-苦力工

* Version:  1.1

* Date:    03/08/2008

* Modify:

* Description:

* Copyright notice

*/

 

Ø        包和引入语句

在Java源文件中，第一个非注释行是Package语句。Package 行要在 Import 行之前，Import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。例如：

  package java.awt;

  import java.awt.peer.CanvasPeer;

  import java.io.InputStream;

  import cn.edu.cuit.TestApplication;

 

Ø        类和接口声明

下表描述了类和接口声明的各个部分以及它们出现的先后次序。

 

序号	类/接口声明的各部分	注解
1	类/接口文档注释(/**……*/)	该注释中所需包含的信息。
2	类或接口的声明
3	类/接口实现的注释(/*……*/)如果有必要的话	该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。
4	类的(静态)变量	首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。
5	实例变量	首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。
6	构造器
7	方法	这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

转载请注明：http://javadt.com