3-文件组织
文章目录
3-文件组织
一个文件由应以空行分隔的部分和标识每个部分的可选注释组成。
一个文件超过2000行的代码会显得很麻烦,应该避免出现这样情况。
3.1 java 源代码文件
每个源文件包含一个单独的公开类或者接口。如果这个公开类有关联的私有类或者接口,可以把他们放在同一个文件里,必须放在公开类的下面。
java源文件的内容有以下几部分:
- 头部注释(参考:)
- 包的声明和导入声明
- 类和接口声明
3.1.1 头部注释
所有源文件应以c样式注释开头,其中列出了类名,版本信息,日期和版权声明:
/*
* 类名
*
* 版本信息
*
* 日期
*
* 版权声明
*/
3.1.2 包的声明和导入声明
大多数Java源文件的第一个非注释行是一个package语句。之后,可以进行import语句。例如:
package java.awt;
import java.awt.peer.CanvasPeer;
3.1.3 类和接口声明
下表按照它们应该出现的顺序描述了类或接口声明的各个部分。
| 顺序 | 类和接口声明 | 描述 | |
|---|---|---|---|
| 1 | 类/接口 文档注释(/**...*/) |
参考 "文档注释" 了解该评论应该包含哪些内容。 | |
| 2 | 类/接口 声明 | ||
| 3 | 类/接口的实现注释(/*...*/), 可省略 |
这种注释包含所有不适合放在类/接口文档注释的其他信息 | |
| 4 | 类(静态) 变量 | 首先是public 类变量,然后是protected,然后是包级别(无访问修饰符),最后是private。 |
|
| 5 | 实例变量 | 首先是public 类变量,然后是protected,然后是包级别(无访问修饰符),最后是private。 |
|
| 6 | 构造函数 | ||
| 7 | 方法 | 这些方法应该按照功能而不是范围或可访问性进行分组。例如,私有类方法可以位于两个公共实例方法之间。目标是让阅读和理解代码更容易。 |
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论