Java 程式碼慣例 -- 第三章 檔案組織

3. 檔案組織

由許多小節組成的檔案應該用 "空白行" 以及 "用來辨認每個小節的選擇性註解" 分隔。

超過 2000 行的檔案是很累贅的，應該避免。

Java 程式適當格式的範例請參考 11.1 的 "Java 原始碼檔案範例"。





3.1 Java 原始碼檔案

每一個 Java 原始碼檔案都包含了一個單一的 public class/interface。
如果 private classes/interfaces 和 public class 相關，那你應該把
他們跟 public class 原始碼檔案放在一起。public 應該是這個檔案中的
第一個 calss/interface。

Java 原始碼檔案有下列順序：
* 起始註解(參見 3.1.1 "起始註解")
* package 和 import 敘述
* class 和 interface 宣告(參見 3.1.3 "class 和 interface 宣告")





3.1.1 起始註解

所有的原始碼檔案都應該以 C 語言型態的註解起始，列出類別名稱，版本資訊，日期和版權宣告。

/*
* 類別名稱
*
* 版本資訊
*
* 日期
*
* 版權宣告
*/




3.1.2 package 和 import 敘述

大多數 Java 原始碼檔案的第一行非註解行都是 package 敘述。在這之後
跟著 import 敘述。例如：

package java.awt;
import java.awt.peer.CanvasPeer;




3.1.3 class 和 interface 宣告

下列表格描述了一個 class/interface 的宣告部份，以他們應該出現的順序排列。
參考 11.1 "Java 原始碼檔案範例" 來看包含註解的範例。

| class/interface
| 宣告部份 備註
-----------------------------------------------------------------
1 | class/interface 文件 參考 5.2 "文件註解" 來查看
| 註解 (/**...*/) 這註解中應該有甚麼資訊。
|
2 | class/interface 敘述
|
3 | class/interface 實作註解 這註解應該包含任何不適合做為
| (/*...*/)，如果需要的話 class/interface 文件註解的
| class/interface 廣度的資訊。
|
4 | 類別 (static) 變數 首先是 public 的類別變數，然後是
| protected，再接著是 package 層級 (
| 沒有存取修正子)，最後是 private。
|
5 | 實體變數 首先是 public，然後 protected，然後
| package(沒有存取修正子)，最後是
| private。
|
6 | 建構子
|
7 | 方法 方法應該以功能來分群，而不是以視野
| 或是存取權限分。例如 private 的
| 類別方法可以在兩個 public 實體方
| 法中間。目的是為了讓程式碼更容易閱
| 讀和了解。