包含java作者代碼末班的詞條

本文目錄一覽：

• 1、eclipse怎麼設置創建一個java文件後自動加入注釋
• 2、java軟體開發的代碼規範
• 3、java實現模板

eclipse怎麼設置創建一個java文件後自動加入注釋

eclipse設置創建一個java文件後自動加入注釋的方法：

1、通過菜單 Window-Preference 打開參數設置面板，然後選擇：

Java – Code Style – Code  Templates

2、在右側選擇Comments,將其中的Files項，然後選右邊的”Edit”，進入編輯模式：   

3、進入編輯模式後就可以自定義注釋了。另外可以插入一些變數，如年、日期等等。

4、最後，確保 Code – New Java files 中有：”${filecomment}”

java軟體開發的代碼規範

1、組織與風格

(1).關鍵詞和操作符之間加適當的空格。

(2).相對獨立的程序塊與塊之間加空行

(3).較長的語句、表達式等要分成多行書寫。

(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。

(5).長表達式要在低優先順序操作符處劃分新行，操作符放在新行之首。

(6).循環、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分。

(7).若函數或過程中的參數較長，則要進行適當的劃分。

(8).不允許把多個短語句寫在一行中，即一行只寫一條語句。

(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要採用縮進風格。

註：如果大家有興趣可以到安安DIY創作室博客，有相關說明性的文章和解釋。

2、註解

Java 的語法與 C++ 及為相似，那麼，你知道 Java 的注釋有幾種嗎？是兩種？

// 注釋一行

/* …… */ 注釋若干行

不完全對，除了以上兩種之外，還有第三種，文檔注釋：

/** …… */ 注釋若干行，並寫入 javadoc 文檔

注釋要簡單明了。

String userName = null; //用戶名

邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。

在必要的地方注釋，注釋量要適中。注釋的內容要清楚、明了，含義準確，防止注釋二義性。

保持注釋與其描述的代碼相鄰，即注釋的就近原則。

對代碼的注釋應放在其上方相鄰位置，不可放在下面。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；

同一結構中不同域的注釋要對齊。

變數、常量的注釋應放在其上方相鄰位置或右方。

全局變數要有較詳細的注釋，包括對其功能、取值範圍、哪些函數或過程存取它以及存取時注意事項等的說明。

在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要演算法、內部各部分之間的關係、該文件與其它文件關係等）；主要函數或過程清單及本文件歷史修改記錄等。

/**

* Copy Right Information : Neusoft IIT

* Project : eTrain

* JDK version used : jdk1.3.1

* Comments : config path

* Version : 1.01

* Modification history :2003.5.1

* Sr Date Modified By Why What is modified

* 1. 2003.5.2 Kevin Gao new

**/

在每個函數或過程的前面要有必要的注釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關係及被調用關係說明等

/**

* Description :checkout 提款

* @param Hashtable cart info

* @param OrderBean order info

* @return String

*/

public String checkout(Hashtable htCart,

OrderBean orderBean)

throws Exception{

}

javadoc注釋標籤語法

@author 對類的說明 標明開發該類模塊的作者

@version 對類的說明 標明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉向，也就是相關主題

@param 對方法的說明 對方法中某參數的說明

@return 對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進行說明

3、命名規範

定義這個規範的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規範並不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過去掉母音形成縮寫；要不然最後自己寫的代碼自己都看不懂了，那可不行。

較長的單詞可取單詞的頭幾發符的優先順序，並用括弧明確表達式的操作順序，避免使用默認優先順序。

使用匈牙利表示法

Package 的命名

Package 的名字應該都是由一個小寫單片語成。

package com.neu.util

Class 的命名

Class 的名字必須由大寫字母開頭而其他字母都小寫的單片語成,對於所有標識符，其中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。

public class ThisAClassName{}

Class 變數的命名

變數的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭

userName , thisAClassMethod

Static Final 變數的命名

static Final 變數的名字應該都大寫，並且指出完整含義。

/**

*DBConfig PATH

**/

public static final String

DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;

參數的命名

參數的名字必須和變數的命名規範一致。

數組的命名

數組應該總是用下面的方式來命名：

byte[] buffer;

而不是：

byte buffer[];

方法的參數

使用有意義的參數命名，如果可能的話，使用和要賦值的欄位一樣的名字：

SetCounter(int size){

this.size = size;

}

4、文件樣式

所有的 Java(*.java) 文件都必須遵守如下的樣式規則：

版權信息

版權信息必須在 java 文件的開頭，比如：

/*

* Copyright ? 2000 Shanghai XXX Co. Ltd.

* All right reserved.

*/

其他不需要出現在 javadoc 的信息也可以包含在這裡。

Package/Imports

package 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母

順序排列。如果 import 行中包含了同一個包中的不同子目錄，則應該用 * 來處理。

package hotlava.net.stats;

import java io.*;

import java.util.Observable;

import hotlava.util.Application;

這裡 java。io.* 使用來代替InputStream and OutputStream 的。

Class

接下來的是類的注釋，一般是用來解釋類的。

/**

* A class representing a set of packet and byte counters

* It is observable to allow it to be watched, but only

* reports changes when the current set is complete

*/

接下來是類定義，包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

接下來是類的成員變數：

/**

* Packet counters

*/

protected int[] packets;

public 的成員變數必須生成文檔（JavaDoc）。proceted、private和 package 定義的成

員變數如果名字含義明確的話，可以沒有注釋。

存取方法

接下來是類變數的存取的方法。它只是簡單的用來將類的變數賦值獲取值的話，可以簡單的

寫在一行上。

/**

* Get the counters

* @return an array containing the statistical data. This array has been

* freshly allocated and can be modified by the caller.

*/

public int[] getPackets() { return copyArray(packets, offset); }

public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }

public void setPackets(int[] packets) { this.packets = packets; }

其它的方法不要寫在一行上

構造函數

接下來是構造函數，它應該用遞增的方式寫（比如：參數多的寫在後面）。

訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應該在一行

中，並且方法和參數另寫一行，這樣可以使方法和參數更易讀。

public

CounterSet(int size){

this.size = size;

}

克隆方法

如果這個類是可以被克隆的，那麼下一步就是 clone 方法：

public

Object clone() {

try {

CounterSet obj = (CounterSet)super.clone();

obj.packets = (int[])packets.clone();

obj.size = size;

return obj;

}catch(CloneNotSupportedException e) {

throw new InternalError(Unexpected CloneNotSUpportedException: +

e.getMessage());

}

}

類方法

下面開始寫類的方法：

/**

* Set the packet counters

* (such as when restoring from a database)

*/

protected final

void setArray(int[] r1, int[] r2, int[] r3, int[] r4)

throws IllegalArgumentException

{

//

// Ensure the arrays are of equal size

//

if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)

throw new IllegalArgumentException(Arrays must be of the same size);

System.arraycopy(r1, 0, r3, 0, r1.length);

System.arraycopy(r2, 0, r4, 0, r1.length);

}

toString 方法

無論如何，每一個類都應該定義 toString 方法：

public

String toString() {

String retval = CounterSet: ;

for (int i = 0; i data.length(); i++) {

retval += data.bytes.toString();

retval += data.packets.toString();

}

return retval;

}

}

main 方法

如果main(String[]) 方法已經定義了, 那麼它應該寫在類的底部.

5、代碼可讀性

避免使用不易理解的數字，用有意義的標識來替代。

不要使用難懂的技巧性很高的語句。

源程序中關係較為緊密的代碼應儘可能相鄰。

6、代碼性能

在寫代碼的時候，從頭至尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上，而是我們時刻應該提醒自己要注意代碼的效率。比如：如果沒有時間來實現一個高效的演算法，那麼我們應該在文檔中記錄下來，以便在以後有空的時候再來實現她。

不是所有的人都同意在寫代碼的時候應該優化性能這個觀點的，他們認為性能優化的問題應該在項目的後期再去考慮，也就是在程序的輪廓已經實現了以後。

不必要的對象構造

不要在循環中構造和釋放對象

使用 StringBuffer 對象

在處理 String 的時候要盡量使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。

String 類將 StringBuffer 類封裝了起來，（以花費更多時間為代價）為開發人員提供了一個安全的介面。當我們在構造字元串的時候，我們應該用 StringBuffer 來實現大部分的工作，當工作完成後將 StringBuffer 對象再轉換為需要的 String 對象。比如：如果有一個字元串必須不斷地在其後添加許多字元來完成構造，那麼我們應該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話，會花費許多不必要的創建和釋放對象的 CPU 時間。大家可以來安安DIY創作室一起討論。

避免太多的使用 synchronized 關鍵字避免不必要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。

7、編程技巧

byte 數組轉換到 characters

為了將 byte 數組轉換到 characters，你可以這麼做：

Hello world!.getBytes();

Utility 類

Utility 類（僅僅提供方法的類）應該被申明為抽象的來防止被繼承或被初始化。

初始化

下面的代碼是一種很好的初始化數組的方法：

objectArguments = new Object[] { arguments };

枚舉類型

JAVA 對枚舉的支持不好，但是下面的代碼是一種很有用的模板：

class Colour {

public static final Colour BLACK = new Colour(0, 0, 0);

public static final Colour RED = new Colour(0xFF, 0, 0);

public static final Colour GREEN = new Colour(0, 0xFF, 0);

public static final Colour BLUE = new Colour(0, 0, 0xFF);

public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);

}

這種技術實現了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。

他們可以用 ‘==’ 操作符來比較。

但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創建顏色 BLACK new Colour(0,0,0)

那麼這就是另外一個對象，’==’操作符就會產生錯誤。她的 equal() 方法仍然有效。由於這個原因，這個技術的缺陷最好註明在文檔中，或者只在自己的包中使用。

8、編寫格式

代碼樣式

代碼應該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）

文檔化

必須用 javadoc 來為類生成文檔。不僅因為它是標準，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因為代碼不應該是被個人擁有的。

縮進

縮進應該是每行2個空格. 不要在源文件中保存Tab字元. 在使用不同的源代碼管理工具時Tab字元將因為用戶設置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字元, 方法是通過 UltrEdit中先設定 Tab 使用的長度室2個空格，然後用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。

頁寬

頁寬應該設置為80字元. 源代碼一般不會超過這個寬度, 並導致無法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符後折行. 一條語句折行後, 應該比原來的語句再縮進2個字元.

{} 對

{} 中的語句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:

if (i0) { i ++ }; // 錯誤, { 和 } 在同一行

if (i0) {

i ++

}; // 正確, { 單獨作為一行

} 語句永遠單獨作為一行.如果 } 語句應該縮進到與其相對應的 { 那一行相對齊的位置。

括弧

左括弧和後一個字元之間不應該出現空格, 同樣, 右括弧和前一個字元之間也不應該出現空格. 下面的例子說明括弧和空格的錯誤及正確使用:

CallProc( AParameter ); // 錯誤

CallProc(AParameter); // 正確

不要在語句中使用無意義的括弧. 括弧只應該為達到某種目的而出現在源代碼中。下面的例子說明錯誤和正確的用法:

if ((I) = 42) { // 錯誤 – 括弧毫無意義

if (I == 42) or (J == 42) then // 正確 – 的確需要括弧

9、代碼編譯

1.編寫代碼時要注意隨時保存，並定期備份，防止由於斷電、硬碟損壞等原因造成代碼丟失。

2.同一項目組內，最好使用相同的編輯器，並使用相同的設置選項。

3.合理地設計軟體系統目錄，方便開發人員使用。

4.打開編譯器的所有告警開關對程序進行編譯。

5.在同一項目組或產品組中，要統一編譯開關選項。

6.使用工具軟體（如Visual SourceSafe）對代碼版本進行維護。如果大家有不明白的可以到安安DIY創作室留言。

10、可移植性

Borland Jbulider 不喜歡 synchronized 這個關鍵字，如果你的斷點設在這些關鍵字的作用域內的話，調試的時候你會發現的斷點會到處亂跳，讓你不知所措。除非必須，盡量不要使用。

換行

如果需要換行的話，盡量用 println 來代替在字元串中使用\n。

你不要這樣：

System.out.print(Hello,world!\n);

要這樣：

System.out.println(Hello,world!);

或者你構造一個帶換行符的字元串，至少要象這樣：

String newline = System.getProperty(line.separator);

System.out.println(Hello world + newline);

PrintStream

PrintStream 已經被不贊成（deprecated）使用，用 PrintWrite 來代替它。

java實現模板

java無法像c++那樣定義模板，只能是以邏輯的形式（上述例子中抽象類中隱含強制了子類的行為）。

上面的例子很簡單，java也沒法寫出看上去就很複雜的代碼（如果真有那是水平差的表現），它在父類中規範了子類的行為，起到了模板的作用。