java學習(1)--註釋文檔和編碼規範

java有兩種註釋風格,一種是傳統的C語言風格的註釋——C++也繼承了這一種風格。這種註釋以/*開頭 以*/結束。相必都很熟悉了,就不多說。另一種是單行註釋 也就是以“//”開頭直到句末。

關於註釋文檔

爲了使文檔和代碼的連接性更強,最好的方法是把代碼和文檔聯結起來,最簡單的辦法就是把所有東西都放到一個文件裏。這就需要用到了一種特殊的註釋語法來標記文檔;此外還需要一個工具來提取這些註釋,並將它們轉換成有用的形式,這個工具就是javadoc,他是jdk安裝的一部分。javadoc輸出的是一個HTML文件,可以用瀏覽器進行查看,如果要對javadoc處理過的信息執行特殊的操作,暗惡魔可以編寫自己的被稱爲“doclets”的javadoc處理器來實現。(doclets參見http://MindView.net/Books/Better Java所提供的補充材料)

語法

所有javadoc命令都在“/**”註釋中出現,註釋部分結束還是“*/”。javadoc使用的方式主要有兩種:嵌入式HTML,或者使用“文檔標籤”。獨立文檔標籤是一些以“@”字符開頭的命令,並且要放在註釋行的最前面(不算前導“*”)。行內文檔標籤可以出現在javadoc註釋中的任何地方,也是以“@”開頭,但是要括在花括號裏面。
三種類型的註釋文檔,對應註釋位置後面的三種元素:類,域和方法。

/**A class comment*/
public class Document {
    /**A filed comment*/
    public int a;
    /**A method comment*/
    public void f(){
        
    }
}///:~

注意:javadoc只對公共和保護成員進行文檔註釋有效,不過可以使用-private進行標記。
生成方法:

//javadoc -d ***(輸出的文件夾名字) **.java(文件來源)
//example
java -d mydoc Document.java

嵌入式HTML

可以嵌入一些html格式 但是不要使用標題標籤 因爲可能會和javadoc插入的自己的標籤衝突。

標籤示例

1.@see:引用其他類
允許客戶引用其他類的文檔,在生成的HTML文件當中,會通過@see標籤連接到其他文件(插入超鏈接See Also)
2.{@link package.class#member label}
用法和see相似,但是這個用於行內,同時用label作爲超鏈接文本而不是see also
3.{@docRoot}
該文檔產生到文檔根目錄的相對路徑,用於文檔樹頁面的顯式超鏈接
4.{@inheritDoc}
該標籤從當前這個類的最直接的基類中繼承相關文檔到當前的文檔註釋中
5.@version
使用格式:@version version-information
6.@author
@author author-information
7.@since
該標籤允許指定程序代碼最早使用的版本
8.@param
用於方法文檔:@param parameter-name description
parameter-name 參數名
description:可延續數行的文本終止於新的文檔標籤出現之前
9.@return
@return description
描述返回值的含義 可數行
10.@throws
@throws fully-qualified-class-name description / /拋出 異常類名稱 類的描述
11.@deprecated
這個標籤用來指出一些舊特性已經由改進的新特性所取代,建議用戶不要使用這些舊特性,因爲在不久的將來他們很可能會被刪除。若使用了一個被標爲@deprecated的方法會引起編譯器發出警告。
在javaSE5中,@deprecated已經被@Deprecated替代。

JAVA編碼風格

類的首字母大寫;如果類名由幾個單詞構成,那麼把他們並在一起,其中每個單詞首字母大寫。(駝峯風格)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章