JDK 包含 個(gè)很有用的工具，叫做javadoc ，它可以由源文件生成 HTML 文檔。事
實(shí)上，在第 章講述的聯(lián)機(jī) API 文檔就是通過對標(biāo)準(zhǔn) Java 類庫的源代碼運(yùn)行javadoc
成的
如果在源代碼中添加以專用的定界符／＊＊開始的注釋，那么可以很容易地生成 個(gè)看上
去具有專業(yè)水準(zhǔn)的文檔 這是一種很好的方式，因?yàn)檫@種方式可以將代碼與注釋保存在一個(gè)
地方 如果將文檔存入 個(gè)獨(dú)立的文件中，就有可能會隨著時(shí)間的推移，出現(xiàn)代碼和注釋不
致的問題 然而，由于文檔注釋與源代碼在同 個(gè)文件中，在修改源代碼的同時(shí)， 重新運(yùn)
javadoc 就可以輕而易舉地保持兩者的一致性

注釋的插入
javadoc 實(shí)用程序（utility ）從下面幾個(gè)特性中抽取信息：
．包
·公有類與接口
·公有的和受保護(hù)的構(gòu)造器及方法
·公有的和受保護(hù)的域
在第 章中將介紹受保護(hù)特性，在第 章將介紹接口
應(yīng)該為上面幾部分編寫注釋 注釋應(yīng)該放置在所描述特性的前面 注釋以／忡開始，并
以＊／結(jié)束
每個(gè)／＊＊ ．．． ／文檔注釋在標(biāo)記之后緊跟著自由格式文本（ free-form text ）。 標(biāo)記由 ＠開
始，如＠author 或＠param
自由格式文本的第一句應(yīng)該是一個(gè)概要性的句子 javadoc 實(shí)用程序自動(dòng)地將這些句子抽
取出來形成概要頁
在自由格式文本中，可以使用 HT~ 修飾符，例如，用于強(qiáng)調(diào)的＜em>... </em
著重強(qiáng)調(diào)的＜ trong ... </ strong＞以及包含圖像的＜img ... ＞等 不過，－定不要使用＜hl ＞或
＞，因?yàn)樗鼈儠c文檔的格式產(chǎn)生沖 若要鍵入等寬代碼， 使用｛＠code ... ｝而不是
code＞…＜／code 一寸主樣 來，就不用操心對代碼中的＜字符轉(zhuǎn)義了

注釋：如果文檔中有到其他文件的鏈接，例如，圖像文件 用戶界面的組件的圖表或
像等），就應(yīng)該將這些文件放到子目錄 doc-files javadoc 實(shí)用程序?qū)脑茨夸浛截愡@
些目錄及其中的文件到文檔目錄中 在鏈接中需妥使用 doc-files 目錄，例如：＜img src
“ doc-files/um!. png ” alt=“UMLdiagram ”＞
4.9.2 類注釋
類注釋必須放在 import 語句之后，類定義之前

方法注釋
每一個(gè)方法注釋必須放在所描述的方法之前 除了通用標(biāo)記之外，還可以使用下面的標(biāo)記：
? @param 描述
這個(gè)標(biāo)記將對當(dāng)前方法的“ param ”（參數(shù)）部分添加一個(gè)條目 這個(gè)描述可以占據(jù)多
行，并可以使用 HTML 標(biāo)記。一個(gè)方法的所有＠param 標(biāo)記必須放在
? @return 描述
這個(gè)標(biāo)記將對當(dāng)前方法添加“ return ”（返回）部分 這個(gè)描述可以跨越多行，井可以
使用 HTML 標(biāo)記
? @throws 描述
這個(gè)標(biāo)記將添加 個(gè)注釋，用于表示這個(gè)方法有可能拋出異常 有關(guān)異常的詳細(xì)內(nèi)容
將在第 10 中討論
下面是 個(gè)方法注釋的示例：

域注釋
只需要對公有域（通常指的是靜態(tài)常量）建立文檔 例如，

總結(jié)

以上是生活随笔為你收集整理的java 文档注释的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。