注釋的插入
javadoc工具可以由源文件生成一個HTML文件密任。javadoc實用程序從下面幾個特性中抽取信息：
1.包
2.公有類與接口
3.公有的和受保護的構(gòu)造器及方法
4.公有的和受保護的域
應(yīng)該為上面幾部分編寫注釋。注釋應(yīng)該放置在所描述特性的前面，以/**開始捅位，并以*/結(jié)束。每個文檔注釋在標(biāo)記之后緊跟著自由文本格式（free-form text）印颤。標(biāo)記由@開始事甜，如@author或@param。
自由格式文本的第一句應(yīng)該是一個概要性的句子佳簸。javadoc應(yīng)用程序自動地將這些句子抽取出來形成概要頁乙墙。
通用注釋
下面的標(biāo)記可以用在類文檔的注釋中。
- @author姓名
這個標(biāo)記將產(chǎn)生一個“author”（作者）條目√耄可以使用多個 @author標(biāo)記腥刹，每個@author標(biāo)記對應(yīng)一名作者。 - @version文本
產(chǎn)生一個“version”（版本）條目汉买。這里的文本可以是對當(dāng)前版本的任何描述衔峰。
下面的標(biāo)記可以用所有的文檔注釋中。
- @since文本
產(chǎn)生一個“since”（始于）條目蛙粘。這里的文本可以是對引入特性的版本描述垫卤。 - @see文本
這個標(biāo)記將在“see also”部分增加一個超級鏈接。
類注釋
類注釋必須放在import語句之后组题，類定義之前葫男。
方法注釋
每一個方法注釋必須放在所描述的方法之前。除了通用標(biāo)記外崔列，還可以使用下列標(biāo)記：
- @param變量描述
這個標(biāo)記將對當(dāng)前方法的“param”（參數(shù)）部分添加一個條目梢褐。這個描述可以占據(jù)多行，并可以使用HTML標(biāo)記赵讯。一個方法的所有@param標(biāo)記必須放在一起盈咳。 - @return描述
這個標(biāo)記將對當(dāng)前方法添加“return”（返回）部分。這個描述可以跨越多行边翼，并可以使用HTML標(biāo)記鱼响。 - @throws類描述
這個標(biāo)記將添加一個注釋，用于表示這個方法有可能拋出異常组底。
