Java語言編碼規范選擇自 hk_von 的 Blog

2019-11-18 14:38:21

字體：大中小

來源：轉載

供稿：網友

　　1 介紹(IntrodUCtion)
1.1為什么要有編碼規范
編碼規范對于程序員而言尤為重要，有以下幾個原因：

- 一個軟件的生命周期中，80%的花費在于維護
- 幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發人員來維護
- 編碼規范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼
- 假如你將源碼作為產品發布，就需要確任它是否被很好的打包并且清楚無誤，一如你已構建的其它任何產品

為了執行規范，每個軟件開發人員必須一致遵守編碼規范。

1.2版權聲明
本文檔反映的是Sun MicroSystems公司，java語言規范中的編碼標準部分。主要貢獻者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。

本文檔現由Scott Hommel維護，有關評論意見請發至shommel@eng.sun.com

2.文件名
這部分列出了常用的文件名及其后綴。

2.1文件后綴
Java程序使用下列文件后綴

文件類別文件后綴
Java源文件 .java
Java字節碼文件 .class

2.2常用文件名
Java程序使用下列文件后綴

文件類別文件后綴
Java源文件 .java
Java字節碼文件 .class

3.文件組織
一個文件由被空行分割而成的段落以及標識每個段落的可選注釋共同組成。超過2000行的程序難以閱讀，應該盡量避免。"Java源文件范例"提供了一個布局合理的Java程序范例。

3.1jAVA源文件
每個Java源文件都包含一個單一的公共類或接口。若私有類和接口與一個公共類相關聯，可以將它們和公共類放入同一個源文件。公共類必須是這個文件中的第一個類或接口。

Java源文件還遵循以下規則：

- 開頭注釋（參見"開頭注釋"）
- 包和引入語句（參見"包和引入語句"）
- 類和接口聲明（參見"類和接口聲明"）

3.1.1開頭注釋
所有的源文件都應該在開頭有一個C語言風格的注釋，其中列出類名、版本信息、日期和版權聲明：

/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/

3.1.2包和引入語句
在多數Java源文件中，第一個非注釋行是包語句。在它之后可以跟引入語句。例如：

package java.awt;

import java.awt.peer.Canvaspeer;

3.1.3類和接口說明
下表描述了類和接口聲明的各個部分以及它們出現的先后次序。參見"Java源文件范例"中一個包含注釋的例子。

類/接口聲明的各部分注解
1 類/接口文檔注釋(/**……*/) 該注釋中所需包含的信息，參見"文檔注釋"
2 類或接口的聲明
3 類/接口實現的注釋(/*……*/)假如有必要的話該注釋應包含任何有關整個類或接口的信息，而這些信息又不適合作為類/接口文檔注釋。
4 類的(靜態)變量首先是類的公共變量，隨后是保護變量，再后是包一級別的變量(沒有訪問修飾符，access modifier)，最后是私有變量。
5 實例變量首先是公共級別的，隨后是保護級別的，再后是包一級別的(沒有訪問修飾符)，最后是私有級別的。
6 構造器
7 方法這些方法應該按功能，而非作用域或訪問權限，分組。例如，一個私有的類方法可以置于兩個公有的實例方法之間。其目的是為了更便于閱讀和理解代碼。

4.縮進排版
4個空格常被作為縮進排版的一個單位?？s進的確切解釋并未具體指定(空格 vs. 制表符)。一個制表符等于8個空格(而非4個)。

4.1行長度
盡量避免一行的長度超過80個字符，因為很多終端和工具不能很好處理之。

注重：用于文檔中的例子應該使用更短的行長，長度一般不超過70個字符。

4.2換行
當一個表達式無法容納在一行內時，可以依據如下一般規則斷開之：

- 在一個逗號后面斷開

上一篇：開源技術：Eclipse 插件功能研究

下一篇：Java語言編碼規范（2）