我看動力節(jié)點的java基礎(chǔ)大全301集教中的三種注釋方法：
專注于為中小企業(yè)提供成都網(wǎng)站建設(shè)、成都做網(wǎng)站服務(wù),電腦端+手機端+微信端的三站合一,更高效的管理,為中小企業(yè)浮山免費做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都，凝聚了一批互聯(lián)網(wǎng)行業(yè)人才，有力地推動了數(shù)千家企業(yè)的穩(wěn)健成長，幫助中小企業(yè)通過網(wǎng)站建設(shè)實現(xiàn)規(guī)模擴充和轉(zhuǎn)變。
1、單行注釋?? //注釋的內(nèi)容
2、多行注釋??/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記：
特別聲明：
（1）javadoc針對public類生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導(dǎo)*號和HTML標簽
（4）javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應(yīng)用：
（1）首先編寫.java文件
（2）在命令行中執(zhí)行以下dos命令：
javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說明語句生成HTML文檔
//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。
（3）在當前目錄下就會產(chǎn)生doc文件夾，里面有一系列的.html文件
附上代碼：
[java]?view plain?copy
span?style="font-size:18px;"*/
/**javadoc注釋的內(nèi)容
*/
public?class?Hello{
/**屬性上的注釋*/
public?String?name;
/**這是main方法,是程序的入口
*@param?args?用戶輸入?yún)?shù)
*/
public?static?void?main(String[]?args){
System.out.println("Hello?World!");
f1();
}
/**?這是第1個方法,其作用是...*/
public?static?void?f1(){
System.out.println("f1()！");
}
}/span
[java]?view plain?copy
span?style="font-size:18px;"import?java.io.IOException;
/**javadoc注釋內(nèi)容
*@since?1.0
*@version?1.1
*@author?Blue?Jey
*br鏈接到另一個文檔{@link?Hello},就這些
*see?Hello
*/
public?class?HelloWorld{
/**非public，protected?屬性上的注釋不生成*/
public?String?name;
/**這是main方法，是程序的入口
*@param?args?用戶輸入的參數(shù)，是數(shù)組
*@throws?IOException?main方法io異常
*/
public?static?void?main(String?args[])?throws?IOException{
System.out.println("hello?World!");
f1();
f2(1);
}
/**這是第一個方法，其作用是....
*@deprecated?從版本1.2開始，不再建議使用此方法
*/
public?static?void?f1(){
System.out.println("fl()!");
}
/**這是第二個方法，其作用是....
*@return?返回是否OK
*@param?i?輸入?yún)?shù)i
*@see?Hello
*@throws?IOException?io異常
*/
public?static?String?f2(int?i)throws?IOException{
System.out.println("f1()!");
return?"OK";
}
}?/span
注意：
如果源文件中有用到@version,@author標記，則在執(zhí)行javadoc命令時，要加-version?-author
javadoc?-version?-author?-d?doc?*.java
（其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息）
1、組織與風格
(1).關(guān)鍵詞和操作符之間加適當?shù)目崭瘛?/p>
(2).相對獨立的程序塊與塊之間加空行
(3).較長的語句、表達式等要分成多行書寫。
(4).劃分出的新行要進行適應(yīng)的縮進，使排版整齊，語句可讀。
(5).長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。
(6).循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應(yīng)的劃分。
(7).若函數(shù)或過程中的參數(shù)較長，則要進行適當?shù)膭澐帧?/p>
(8).不允許把多個短語句寫在一行中，即一行只寫一條語句。
(9).函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格。
注：如果大家有興趣可以到安安DIY創(chuàng)作室博客，有相關(guān)說明性的文章和解釋。
2、注解
Java 的語法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？
// 注釋一行
/* ...... */ 注釋若干行
不完全對，除了以上兩種之外，還有第三種，文檔注釋：
/** ...... */ 注釋若干行，并寫入 javadoc 文檔
注釋要簡單明了。
String userName = null; //用戶名
邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。
在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性。
保持注釋與其描述的代碼相鄰，即注釋的就近原則。
對代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋應(yīng)放在此域的右方；
同一結(jié)構(gòu)中不同域的注釋要對齊。
變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。
全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。
在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過程清單及本文件歷史修改記錄等。
/**
* 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
**/
在每個函數(shù)或過程的前面要有必要的注釋信息，包括：函數(shù)或過程名稱；功能描述；輸入、輸出及返回值說明；調(diào)用關(guān)系及被調(diào)用關(guān)系說明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注釋標簽語法
@author 對類的說明 標明開發(fā)該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉(zhuǎn)向，也就是相關(guān)主題
@param 對方法的說明 對方法中某參數(shù)的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明
3、命名規(guī)范
定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過去掉元音形成縮寫；要不然最后自己寫的代碼自己都看不懂了，那可不行。
較長的單詞可取單詞的頭幾發(fā)符的優(yōu)先級，并用括號明確表達式的操作順序，避免使用默認優(yōu)先級。
使用匈牙利表示法
Package 的命名
Package 的名字應(yīng)該都是由一個小寫單詞組成。
package com.neu.util
Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成,對于所有標識符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。
public class ThisAClassName{}
Class 變量的命名
變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭
userName , thisAClassMethod
Static Final 變量的命名
static Final 變量的名字應(yīng)該都大寫，并且指出完整含義。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
參數(shù)的命名
參數(shù)的名字必須和變量的命名規(guī)范一致。
數(shù)組的命名
數(shù)組應(yīng)該總是用下面的方式來命名：
byte[] buffer;
而不是：
byte buffer[];
方法的參數(shù)
使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字：
SetCounter(int size){
this.size = size;
}
4、文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則：
版權(quán)信息
版權(quán)信息必須在 java 文件的開頭，比如：
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。
Package/Imports
package 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母
順序排列。如果 import 行中包含了同一個包中的不同子目錄，則應(yīng)該用 * 來處理。
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; }
其它的方法不要寫在一行上
構(gòu)造函數(shù)
接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。
訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應(yīng)該在一行
中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。
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 方法
無論如何，每一個類都應(yīng)該定義 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[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部.
5、代碼可讀性
避免使用不易理解的數(shù)字，用有意義的標識來替代。
不要使用難懂的技巧性很高的語句。
源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。
6、代碼性能
在寫代碼的時候，從頭至尾都應(yīng)該考慮性能問題。這不是說時間都應(yīng)該浪費在優(yōu)化代碼上，而是我們時刻應(yīng)該提醒自己要注意代碼的效率。比如：如果沒有時間來實現(xiàn)一個高效的算法，那么我們應(yīng)該在文檔中記錄下來，以便在以后有空的時候再來實現(xiàn)她。
不是所有的人都同意在寫代碼的時候應(yīng)該優(yōu)化性能這個觀點的，他們認為性能優(yōu)化的問題應(yīng)該在項目的后期再去考慮，也就是在程序的輪廓已經(jīng)實現(xiàn)了以后。
不必要的對象構(gòu)造
不要在循環(huán)中構(gòu)造和釋放對象
使用 StringBuffer 對象
在處理 String 的時候要盡量使用 StringBuffer 類，StringBuffer 類是構(gòu)成 String 類的基礎(chǔ)。
String 類將 StringBuffer 類封裝了起來，（以花費更多時間為代價）為開發(fā)人員提供了一個安全的接口。當我們在構(gòu)造字符串的時候，我們應(yīng)該用 StringBuffer 來實現(xiàn)大部分的工作，當工作完成后將 StringBuffer 對象再轉(zhuǎn)換為需要的 String 對象。比如：如果有一個字符串必須不斷地在其后添加許多字符來完成構(gòu)造，那么我們應(yīng)該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話，會花費許多不必要的創(chuàng)建和釋放對象的 CPU 時間。大家可以來安安DIY創(chuàng)作室一起討論。
避免太多的使用 synchronized 關(guān)鍵字避免不必要的使用關(guān)鍵字 synchronized，應(yīng)該在必要的時候再使用她，這是一個避免死鎖的好方法。
7、編程技巧
byte 數(shù)組轉(zhuǎn)換到 characters
為了將 byte 數(shù)組轉(zhuǎn)換到 characters，你可以這么做：
Hello world!.getBytes();
Utility 類
Utility 類（僅僅提供方法的類）應(yīng)該被申明為抽象的來防止被繼承或被初始化。
初始化
下面的代碼是一種很好的初始化數(shù)組的方法：
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);
}
這種技術(shù)實現(xiàn)了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。
他們可以用 '==' 操作符來比較。
但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創(chuàng)建顏色 BLACK new Colour(0,0,0)
那么這就是另外一個對象，'=='操作符就會產(chǎn)生錯誤。她的 equal() 方法仍然有效。由于這個原因，這個技術(shù)的缺陷最好注明在文檔中，或者只在自己的包中使用。
8、編寫格式
代碼樣式
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）
文檔化
必須用 javadoc 來為類生成文檔。不僅因為它是標準，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因為代碼不應(yīng)該是被個人擁有的。
縮進
縮進應(yīng)該是每行2個空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時Tab字符將因為用戶設(shè)置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字符, 方法是通過 UltrEdit中先設(shè)定 Tab 使用的長度室2個空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。
頁寬
頁寬應(yīng)該設(shè)置為80字符. 源代碼一般不會超過這個寬度, 并導(dǎo)致無法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長的語句應(yīng)該在一個逗號或者一個操作符后折行. 一條語句折行后, 應(yīng)該比原來的語句再縮進2個字符.
{} 對
{} 中的語句應(yīng)該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:
if (i0) { i ++ }; // 錯誤, { 和 } 在同一行
if (i0) {
i ++
}; // 正確, { 單獨作為一行
} 語句永遠單獨作為一行.如果 } 語句應(yīng)該縮進到與其相對應(yīng)的 { 那一行相對齊的位置。
括號
左括號和后一個字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號和前一個字符之間也不應(yīng)該出現(xiàn)空格. 下面的例子說明括號和空格的錯誤及正確使用:
CallProc( AParameter ); // 錯誤
CallProc(AParameter); // 正確
不要在語句中使用無意義的括號. 括號只應(yīng)該為達到某種目的而出現(xiàn)在源代碼中。下面的例子說明錯誤和正確的用法:
if ((I) = 42) { // 錯誤 - 括號毫無意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括號
9、代碼編譯
1.編寫代碼時要注意隨時保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失。
2.同一項目組內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項。
3.合理地設(shè)計軟件系統(tǒng)目錄，方便開發(fā)人員使用。
4.打開編譯器的所有告警開關(guān)對程序進行編譯。
5.在同一項目組或產(chǎn)品組中，要統(tǒng)一編譯開關(guān)選項。
6.使用工具軟件（如Visual SourceSafe）對代碼版本進行維護。如果大家有不明白的可以到安安DIY創(chuàng)作室留言。
10、可移植性
Borland Jbulider 不喜歡 synchronized 這個關(guān)鍵字，如果你的斷點設(shè)在這些關(guān)鍵字的作用域內(nèi)的話，調(diào)試的時候你會發(fā)現(xiàn)的斷點會到處亂跳，讓你不知所措。除非必須，盡量不要使用。
換行
如果需要換行的話，盡量用 println 來代替在字符串中使用\n。
你不要這樣：
System.out.print(Hello,world!\n);
要這樣：
System.out.println(Hello,world!);
或者你構(gòu)造一個帶換行符的字符串，至少要象這樣：
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已經(jīng)被不贊成（deprecated）使用，用 PrintWrite 來代替它。
Java注解是附加在代碼中的一些元信息，用于一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。
注解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。
1、元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四種。
1.1、@Retention: 定義注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解僅存在于源碼中，在class字節(jié)碼文件中不包含
@Retention(RetentionPolicy.CLASS) // 默認的保留策略，注解會在class字節(jié)碼文件中存在，但運行時無法獲得，
@Retention(RetentionPolicy.RUNTIME) // 注解會在class字節(jié)碼文件中存在，在運行時可以通過反射獲取到
1.2、@Target：定義注解的作用目標
@Target(ElementType.TYPE) //接口、類、枚舉、注解
@Target(ElementType.FIELD) //字段、枚舉的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法參數(shù)
@Target(ElementType.CONSTRUCTOR) //構(gòu)造函數(shù)
@Target(ElementType.LOCAL_VARIABLE)//局部變量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包
由以上的源碼可以知道，他的elementType 可以有多個，一個注解可以為類的，方法的，字段的等等
1.3、@Document：說明該注解將被包含在javadoc中。
1.4、@Inherited：說明子類可以繼承父類中的該注解。
注釋是為了方便自己或代碼維護方更容易地讀懂代碼的用處。
一、背景?
1、當我們第一次接觸某段代碼，但又被要求在極短的時間內(nèi)有效地分析這段代碼，我們需要什么樣的注釋信息？?
2、怎么樣避免我們的注釋冗長而且凌亂不堪呢？?
3、在多人協(xié)同開發(fā)、維護的今天，我們需要怎么樣的注釋來保證高質(zhì)、高交的進行開發(fā)和維護工作呢？?
二、意義?
程序中的注釋是程序設(shè)計者與程序閱讀者之間通信的重要手段。應(yīng)用注釋規(guī)范對于軟件本身和軟件開發(fā)人員而言尤為重要。并且在流行的敏捷開發(fā)思想中已經(jīng)提出了將注釋轉(zhuǎn)為代碼的概念。好的注釋規(guī)范可以盡可能的減少一個軟件的維護成本?,?并且?guī)缀鯖]有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護。好的注釋規(guī)范可以改善軟件的可讀性，可以讓開發(fā)人員盡快而徹底地理解新的代碼。好的注釋規(guī)范可以最大限度的提高團隊開發(fā)的合作效率。長期的規(guī)范性編碼還可以讓開發(fā)人員養(yǎng)成良好的編碼習(xí)慣，甚至鍛煉出更加嚴謹?shù)乃季S能力。?
三、注釋的原則?
1、 注釋形式統(tǒng)一?
在整個應(yīng)用程序中，使用具有一致的標點和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其他項目組發(fā)現(xiàn)他們的注釋規(guī)范與這份文檔不同，按照他們的規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。?
2、 注釋的簡潔?
內(nèi)容要簡單、明了、含義準確，防止注釋的多義性，錯誤的注釋不但無益反而有害。?
3、 注釋的一致性?
在寫代碼之前或者邊寫代碼邊寫注釋，因為以后很可能沒有時間來這樣做。另外，如果有機會復(fù)查已編寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。通常描述性注釋先于代碼創(chuàng)建，解釋性注釋在開發(fā)過程中創(chuàng)建，提示性注釋在代碼完成之后創(chuàng)建。修改代碼的同時修改相應(yīng)的注釋，以保證代碼與注釋的同步。?
4、 注釋的位置?
保證注釋與其描述的代碼相鄰，即注釋的就近原則。對代碼的注釋應(yīng)放在其上方相鄰或右方的位置，不可放在下方。避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋要對齊。?
5、 注釋的數(shù)量?
注釋必不可少，但也不應(yīng)過多，在實際的代碼規(guī)范中，要求注釋占程序代碼的比例達到20%左右。注釋是對代碼的“提示”，而不是文檔，程序中的注釋不可喧賓奪主，注釋太多了會讓人眼花繚亂，注釋的花樣要少。不要被動的為寫注釋而寫注釋。?
6、刪除無用注釋?
在代碼交付或部署發(fā)布之前，必須刪掉臨時的或無關(guān)的注釋，以避免在日后的維護工作中產(chǎn)生混亂。?
7、 復(fù)雜的注釋?
如果需要用注釋來解釋復(fù)雜的代碼，請檢查此代碼以確定是否應(yīng)該重寫它。盡一切可能不注釋難以理解的代碼，而應(yīng)該重寫它。盡管一般不應(yīng)該為了使代碼更簡單便于使用而犧牲性能，但必須保持性能和可維護性之間的平衡。?
8、 多余的注釋?
描述程序功能和程序各組成部分相互關(guān)系的高級注釋是最有用的，而逐行解釋程序如何工作的低級注釋則不利于讀、寫和修改，是不必要的，也是難以維護的。避免每行代碼都使用注釋。如果代碼本來就是清楚、一目了然的則不加注釋，避免多余的或不適當?shù)淖⑨尦霈F(xiàn)。?
9、必加的注釋?
典型算法必須有注釋。在代碼不明晰或不可移植處必須有注釋。在代碼修改處加上修改標識的注釋。在循環(huán)和邏輯分支組成的代碼中添加注釋。為了防止問題反復(fù)出現(xiàn)，對錯誤修復(fù)和解決方法的代碼使用注釋，尤其是在團隊環(huán)境中。?
10、注釋在編譯代碼時會被忽略，不編譯到最后的可執(zhí)行文件中，所以注釋不?
會增加可執(zhí)行文件的大小。?
四、JAVA注釋技巧?
1、空行和空白字符也是一種特殊注釋。利用縮進和空行，使代碼與注釋容易區(qū)?
別，并協(xié)調(diào)美觀。?
2、當代碼比較長，特別是有多重嵌套時，為了使層次清晰，應(yīng)當在一些段落的?
結(jié)束處加注釋（在閉合的右花括號后注釋該閉合所對應(yīng)的起點），注釋不能?
寫得很長，只要能表示是哪個控制語句控制范圍的結(jié)束即可，這樣便于閱讀。?
3、將注釋與注釋分隔符用一個空格分開，在沒有顏色提示的情況下查看注釋時，?
這樣做會使注釋很明顯且容易被找到。?
4、不允許給塊注釋的周圍加上外框。這樣看起來可能很漂亮，但是難于維護。?
5、每行注釋（連同代碼）不要超過120個字(1024×768)，最好不要超過80?
字(800×600)?。?
6、Java編輯器（IDE）注釋快捷方式。Ctrl+/?注釋當前行,再按則取消注釋。?
7、對于多行代碼的注釋，盡量不采用“/*......*/”，而采用多行“//”注釋，?
這樣雖然麻煩，但是在做屏蔽調(diào)試時不用查找配對的“/*......*/”。?
8、注釋作為代碼切換開關(guān)，用于臨時測試屏蔽某些代碼。
盡量使用完整的英文描述符，采用適用于相關(guān)領(lǐng)域的術(shù)語，采用大小寫混合使名字可讀。
JAVA代碼規(guī)范：
(1)類名首字母應(yīng)該大寫。字段、方法以及對象（句柄）的首字母應(yīng)小寫。對于所有標識符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。例如：
ThisIsAClassName
thisIsMethodOrFieldName
若在定義中出現(xiàn)了常數(shù)初始化字符，則大寫static final基本類型標識符中的所有字母。這樣便可標志出它們屬于編譯期的常數(shù)。Java包（Package）屬于一種特殊情況：它們?nèi)际切懽帜福幢阒虚g的單詞亦是如此。對于域名擴展名稱，如com，org，net或者edu等，全部都應(yīng)小寫（這也是Java1.1和Java1.2的區(qū)別之一）。
(2)為了常規(guī)用途而創(chuàng)建一個類時，請采取"經(jīng)典形式"，并包含對下述元素的定義：equals()
hashCode()
toString()
clone()（implement Cloneable）
implement Serializable
(3)對于自己創(chuàng)建的每一個類，都考慮置入一個main()，其中包含了用于測試那個類的代碼。為使用一個項目中的類，我們沒必要刪除測試代碼。若進行了任何形式的改動，可方便地返回測試。這些代碼也可作為如何使用類的一個示例使用。
(4)應(yīng)將方法設(shè)計成簡要的、功能性單元，用它描述和實現(xiàn)一個不連續(xù)的類接口部分。理想情況下，方法應(yīng)簡明扼要。若長度很大，可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便于類內(nèi)代碼的重復(fù)使用（有些時候，方法必須非常大，但它們?nèi)詰?yīng)只做同樣的一件事情）。
(5)設(shè)計一個類時，請設(shè)身處地為客戶程序員考慮一下（類的使用方法應(yīng)該是非常明確的）。然后，再設(shè)身處地為管理代碼的人考慮一下（預(yù)計有可能進行哪些形式的修改，想想用什么方法可把它們變得更簡單）。
(6)使類盡可能短小精悍，而且只解決一個特定的問題。下面是對類設(shè)計的一些建議：
一個復(fù)雜的開關(guān)語句：考慮采用"多形"機制
數(shù)量眾多的方法涉及到類型差別極大的操作：考慮用幾個類來分別實現(xiàn)
許多成員變量在特征上有很大的差別：考慮使用幾個類
(7)讓一切東西都盡可能地"私有"-private。可使庫的某一部分"公共化"（一個方法、類或者一個字段等等），就永遠不能把它拿出。若強行拿出，就可能破壞其他人現(xiàn)有的代碼，使他們不得不重新編寫和設(shè)計。若只公布自己必須公布的，就可放心大膽地改變其他任何東西。在多線程環(huán)境中，隱私是特別重要的一個因素-只有private字段才能在非同步使用的情況下受到保護。
(8)謹惕"巨大對象綜合癥。對一些習(xí)慣于順序編程思維、且初涉OOP領(lǐng)域的新手，往往喜歡先寫一個順序執(zhí)行的程序，再把它嵌入一個或兩個巨大的對象里。根據(jù)編程原理，對象表達的應(yīng)該是應(yīng)用程序的概念。
JAVA代碼規(guī)范：(1) 類名首字母應(yīng)該大寫。字段、方法以及對象（句柄）的首字母應(yīng)小寫。對于所有標識符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。例如：
ThisIsAClassName
thisIsMethodOrFieldName
若在定義中出現(xiàn)了常數(shù)初始化字符，則大寫static final基本類型標識符中的所有字母。這樣便可標志出它們屬于編譯期的常數(shù)。
Java包（Package）屬于一種特殊情況：它們?nèi)际切懽帜?，即便中間的單詞亦是如此。對于域名擴展名稱，如com，org，net或者edu等，全部都應(yīng)小寫（這也是Java 1.1和Java 1.2的區(qū)別之一）。 (2) 為了常規(guī)用途而創(chuàng)建一個類時，請采取"經(jīng)典形式"，并包含對下述元素的定義： equals()
hashCode()
toString()
clone()（implement Cloneable）
implement Serializable (3) 對于自己創(chuàng)建的每一個類，都考慮置入一個main()，其中包含了用于測試那個類的代碼。為使用一個項目中的類，我們沒必要刪除測試代碼。若進行了任何形式的改動，可方便地返回測試。這些代碼也可作為如何使用類的一個示例使用。 (4) 應(yīng)將方法設(shè)計成簡要的、功能性單元，用它描述和實現(xiàn)一個不連續(xù)的類接口部分。理想情況下，方法應(yīng)簡明扼要。若長度很大，可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便于類內(nèi)代碼的重復(fù)使用（有些時候，方法必須非常大，但它們?nèi)詰?yīng)只做同樣的一件事情）。 (5) 設(shè)計一個類時，請設(shè)身處地為客戶程序員考慮一下（類的使用方法應(yīng)該是非常明確的）。然后，再設(shè)身處地為管理代碼的人考慮一下（預(yù)計有可能進行哪些形式的修改，想想用什么方法可把它們變得更簡單）。
(6) 使類盡可能短小精悍，而且只解決一個特定的問題。下面是對類設(shè)計的一些建議：
■一個復(fù)雜的開關(guān)語句：考慮采用"多形"機制
■數(shù)量眾多的方法涉及到類型差別極大的操作：考慮用幾個類來分別實現(xiàn)
■許多成員變量在特征上有很大的差別：考慮使用幾個類 (7) 讓一切東西都盡可能地"私有"--private。可使庫的某一部分"公共化"（一個方法、類或者一個字段等等），就永遠不能把它拿出。若強行拿出，就可能破壞其他人現(xiàn)有的代碼，使他們不得不重新編寫和設(shè)計。若只公布自己必須公布的，就可放心大膽地改變其他任何東西。在多線程環(huán)境中，隱私是特別重要的一個因素--只有private字段才能在非同步使用的情況下受到保護。 (8) 謹惕"巨大對象綜合癥"。對一些習(xí)慣于順序編程思維、且初涉OOP領(lǐng)域的新手，往往喜歡先寫一個順序執(zhí)行的程序，再把它嵌入一個或兩個巨大的對象里。根據(jù)編程原理，對象表達的應(yīng)該是應(yīng)用程序的概念，而非應(yīng)用程序本身。 (9) 若不得已進行一些不太雅觀的編程，至少應(yīng)該把那些代碼置于一個類的內(nèi)部。 (10) 任何時候只要發(fā)現(xiàn)類與類之間結(jié)合得非常緊密，就需要考慮是否采用內(nèi)部類，從而改善編碼及維護工作（參見第14章14.1.2小節(jié)的"用內(nèi)部類改進代碼"）。 (11) 盡可能細致地加上注釋，并用javadoc注釋文檔語法生成自己的程序文檔。 (12) 避免使用"魔術(shù)數(shù)字"，這些數(shù)字很難與代碼很好地配合。如以后需要修改它，無疑會成為一場噩夢，因為根本不知道"100"到底是指"數(shù)組大小"還是"其他全然不同的東西"。所以，我們應(yīng)創(chuàng)建一個常數(shù)，并為其使用具有說服力的描述性名稱，并在整個程序中都采用常數(shù)標識符。這樣可使程序更易理解以及更易維護。 (13) 涉及構(gòu)建器和異常的時候，通常希望重新丟棄在構(gòu)建器中捕獲的任何異常--如果它造成了那個對象的創(chuàng)建失敗。這樣一來，調(diào)用者就不會以為那個對象已正確地創(chuàng)建，從而盲目地繼續(xù)。 (14) 當客戶程序員用完對象以后，若你的類要求進行任何清除工作，可考慮將清除代碼置于一個良好定義的方法里，采用類似于cleanup()這樣的名字，明確表明自己的用途。除此以外，可在類內(nèi)放置一個boolean（布爾）標記，指出對象是否已被清除。在類的finalize()方法里，請確定對象已被清除，并已丟棄了從RuntimeException繼承的一個類（如果還沒有的話），從而指出一個編程錯誤。在采取象這樣的方案之前，請確定finalize()能夠在自己的系統(tǒng)中工作（可能需要調(diào)用System.runFinalizersOnExit(true)，從而確保這一行為）。 (15) 在一個特定的作用域內(nèi)，若一個對象必須清除（非由垃圾收集機制處理），請采用下述方法：初始化對象；若成功，則立即進入一個含有finally從句的try塊，開始清除工作。 (16) 若在初始化過程中需要覆蓋（取消）finalize()，請記住調(diào)用super.finalize()（若Object屬于我們的直接超類，則無此必要）。在對finalize()進行覆蓋的過程中，對super.finalize()的調(diào)用應(yīng)屬于最后一個行動，而不應(yīng)是第一個行動，這樣可確保在需要基礎(chǔ)類組件的時候它們依然有效。 (17) 創(chuàng)建大小固定的對象集合時，請將它們傳輸至一個數(shù)組（若準備從一個方法里返回這個集合，更應(yīng)如此操作）。這樣一來，我們就可享受到數(shù)組在編譯期進行類型檢查的好處。此外，為使用它們，數(shù)組的接收者也許并不需要將對象"造型"到數(shù)組里。 (18) 盡量使用interfaces，不要使用abstract類。若已知某樣?xùn)|西準備成為一個基礎(chǔ)類，那么第一個選擇應(yīng)是將其變成一個interface（接口）。只有在不得不使用方法定義或者成員變量的時候，才需要將其變成一個abstract（抽象）類。接口主要描述了客戶希望做什么事情，而一個類則致力于（或允許）具體的實施細節(jié)。 (19) 在構(gòu)建器內(nèi)部，只進行那些將對象設(shè)為正確狀態(tài)所需的工作。盡可能地避免調(diào)用其他方法，因為那些方法可能被其他人覆蓋或取消，從而在構(gòu)建過程中產(chǎn)生不可預(yù)知的結(jié)果（參見第7章的詳細說明）。 (20) 對象不應(yīng)只是簡單地容納一些數(shù)據(jù)；它們的行為也應(yīng)得到良好的定義。 (21) 在現(xiàn)成類的基礎(chǔ)上創(chuàng)建新類時，請首先選擇"新建"或"創(chuàng)作"。只有自己的設(shè)計要求必須繼承時，才應(yīng)考慮這方面的問題。若在本來允許新建的場合使用了繼承，則整個設(shè)計會變得沒有必要地復(fù)雜。 (22) 用繼承及方法覆蓋來表示行為間的差異，而用字段表示狀態(tài)間的區(qū)別。一個非常極端的例子是通過對不同類的繼承來表示顏色，這是絕對應(yīng)該避免的：應(yīng)直接使用一個"顏色"字段。 (23) 為避免編程時遇到麻煩，請保證在自己類路徑指到的任何地方，每個名字都僅對應(yīng)一個類。否則，編譯器可能先找到同名的另一個類，并報告出錯消息。若懷疑自己碰到了類路徑問題，請試試在類路徑的每一個起點，搜索一下同名的.class文件。 (24) 在Java 1.1 AWT中使用事件"適配器"時，特別容易碰到一個陷阱。若覆蓋了某個適配器方法，同時拼寫方法沒有特別講究，最后的結(jié)果就是新添加一個方法，而不是覆蓋現(xiàn)成方法。然而，由于這樣做是完全合法的，所以不會從編譯器或運行期系統(tǒng)獲得任何出錯提示--只不過代碼的工作就變得不正常了。 (25) 用合理的設(shè)計方案消除"偽功能"。也就是說，假若只需要創(chuàng)建類的一個對象，就不要提前限制自己使用應(yīng)用程序，并加上一條"只生成其中一個"注釋。請考慮將其封裝成一個"獨生子"的形式。若在主程序里有大量散亂的代碼，用于創(chuàng)建自己的對象，請考慮采納一種創(chuàng)造性的方案，將些代碼封裝起來。 (26) 警惕"分析癱瘓"。請記住，無論如何都要提前了解整個項目的狀況，再去考察其中的細節(jié)。由于把握了全局，可快速認識自己未知的一些因素，防止在考察細節(jié)的時候陷入"死邏輯"中。 (27) 警惕"過早優(yōu)化"。首先讓它運行起來，再考慮變得更快--但只有在自己必須這樣做、而且經(jīng)證實在某部分代碼中的確存在一個性能瓶頸的時候，才應(yīng)進行優(yōu)化。除非用專門的工具分析瓶頸，否則很有可能是在浪費自己的時間。性能提升的隱含代價是自己的代碼變得難于理解，而且難于維護。 (28) 請記住，閱讀代碼的時間比寫代碼的時間多得多。思路清晰的設(shè)計可獲得易于理解的程序，但注釋、細致的解釋以及一些示例往往具有不可估量的價值。無論對你自己，還是對后來的人，它們都是相當重要的。如對此仍有懷疑，那么請試想自己試圖從聯(lián)機Java文檔里找出有用信息時碰到的挫折，這樣或許能將你說服。 (29) 如認為自己已進行了良好的分析、設(shè)計或者實施，那么請稍微更換一下思維角度。試試邀請一些外來人士--并不一定是專家，但可以是來自本公司其他部門的人。請他們用完全新鮮的眼光考察你的工作，看看是否能找出你一度熟視無睹的問題。采取這種方式，往往能在最適合修改的階段找出一些關(guān)鍵性的問題，避免產(chǎn)品發(fā)行后再解決問題而造成的金錢及精力方面的損失。 (30) 良好的設(shè)計能帶來最大的回報。簡言之，對于一個特定的問題，通常會花較長的時間才能找到一種最恰當?shù)慕鉀Q方案。但一旦找到了正確的方法，以后的工作就輕松多了，再也不用經(jīng)歷數(shù)小時、數(shù)天或者數(shù)月的痛苦掙扎。我們的努力工作會帶來最大的回報（甚至無可估量）。而且由于自己傾注了大量心血，最終獲得一個出色的設(shè)計方案，成功的快感也是令人心動的。堅持****草草完工的誘惑--那樣做往往得不償失
重慶分公司
重慶分公司
