Java 編碼規範 (轉)

Java 編碼規範 (轉)[@more@]

編碼規範:namespace prefix = o ns = "urn:schemas--com::office" />

翻譯：王士勇

（轉載請保留作者，謝謝）

1．  引言

1．1  為什麼要編碼規範

編碼規範為什麼是重要的？有以下一些理由：

l  一份80%的生命週期是維護期

l  任何軟體都很難說他的整個生命週期都是由他的原始作者來維護

l  編碼規範改善軟體的可讀性，使得軟體工程師充分理解新的程式碼變得非常的。

l  如果你要把你的原碼作為產品釋出，你需要確保他像你的其他產品一樣乾淨並且封裝的好。

為了按照規範工作，每個人寫軟體的時候，都必須遵守編碼規範。記住，是每個人！

1．2  致謝

這本書是反映的是Java Language Specification 中關於java語言編碼規範的。在這裡要著重對Peter king ,Patrick Naughton,Mike DeMoney,Jonni Kanerva,Kathy Walrath,和tt Hommel表示感謝。

2．  名

這一節列出了本書所用的大部分檔名和字尾。

2．1 檔案字尾

  .java  java 原始檔字尾

  .class   java 位元組碼檔案字尾

2．2 常用的檔名

  經常使用的檔名包括以下：

  makefile    首選的makefile的名字，我們使用gnumake來build我們的軟體。

  README   那些專門概述特定資料夾內容的檔案的首選的名字

3．  檔案的組織

一個檔案的各個部分之間應該用空行隔開，並且應該用一個可選的註解來標示每個不同的部分。

檔案超過2000行，是非常笨重討厭（cumbersome）的，應該避免。

至於java 的正確格式的示例，請參看18頁上的”JAVA File Example(Java 原碼檔案示例)”。

3．1 Java 原始碼檔案

  每一個Java原始碼檔案都包括一個唯一的public 類或interface。當私有的類和interface 都和這個public 類有關聯時，你可以把它們放到這個public 類的原始檔中。這個public 類或interface 應當是這個檔案的第一個類或interface 。

Java 原始檔有以下的順序：

l  檔案開頭註解（參見第二頁的“Beginning Comments（開頭註解）”）

l   宣告package 的語句和載入語句。

l  類和interface的宣告（參見page 3的“Class and Interface Declarations”）

3.3.1 開頭註解

  所有的原始檔都應該以一個C語言風格的註解開頭。這個註解應該列出類名，版本資訊，日期和版權宣告：

  /*

  *Classname

  *

  *Version information

  *

  * Date

*

 * copyright notice

 *

 */

3.1.2 宣告包的語句和import 語句

  絕大多數java 原始檔中的第一非註釋行應該是宣告包的語句。此後，緊接著是import 語句。例如：

  package java.awt;

  import java.awt.peer.Canveer;

3.1.3 類和介面的宣告

下面的表格描述了部分的類和介面的宣告，他們應該按照表格的順序。參看“Java Source File Example” on page 18 。