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

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

注釋：如果文檔中有到其他文件的鏈接，例如，圖像文件 用戶界面的組件的圖表或
像等），就應該將這些文件放到子目錄 doc-files javadoc 實用程序將從源目錄拷貝這
些目錄及其中的文件到文檔目錄中 在鏈接中需妥使用 doc-files 目錄，例如：＜img src
“ doc-files/um!. png ” alt=“UMLdiagram ”＞
4.9.2 類注釋
類注釋必須放在 import 語句之后，類定義之前

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

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。