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	方法	這些方法應該按照功能而不是範圍或可訪問性進行分組。例如，私有類方法能夠位於兩個公共實例方法之間。目標是讓閱讀和理解代碼更容易。