斌斌?(給我寫信) 原創博文（http://blog.csdn.net/binbinxyz），轉載請注明出處！

java凝視

java里面有兩種類型的凝視。一種是以“/*”起頭，以“*/”結尾。并能夠跨越多行的凝視。例如以下：

/** 這是一段凝視。* 它跨越了多行*/還有一種是以“//”開頭的凝視。也叫單行凝視，格式例如以下：

// 這是一個單行凝視

凝視文檔

注：本節內容摘自java編程思想第四版2.8.1凝視文檔章節

對于java語言，最體貼的一項設計就是人們也須要考慮程序的文檔化問題。

而對程序的文檔化。最大的問題莫過于對文檔的維護。若文檔與代碼分離。那么每次改變代碼后都要改變文檔，這無疑會變成相當麻煩的一件事情。解決辦法看起來似乎非常easy：將代碼同文檔“鏈接”起來。為達到這個目的，最簡單的方法是將全部內容都置于同一個文件。然而，為使一切都整齊劃一，還必須使用一種特殊的凝視語法，以便標記出特殊的文檔；另外還須要一個工具，用于提取這些凝視，并按有價值的形式將其展現出來。這些都是Java必須做到的。
用于提取凝視的工具叫作javadoc。它採用了部分來自Java編譯器的技術。查找我們置入程序的特殊凝視標記。

它不僅提取由這些標記指示的信息，也將毗鄰凝視的類名或方法名提取出來。

這樣一來，我們就可用最輕的工作量，生成十分專業的程序文檔。
javadoc輸出的是一個HTML文件，可用自己的Web瀏覽器查看。該工具同意我們創建和管理單個源文件，并生動生成實用的文檔。因為有了javadoc。所以我們可以用標準的方法創建文檔。并且因為它很方便，所以我們能輕松獲得全部Java庫的文檔。

javadoc案例

【實驗環境】

MyEclipse 10.0 + jdk 1.6.0_13

【實驗步驟】

一、新建一個java項目doc。

二、新建一個java文件org.hbin.JavaDocTest.java。并加入類凝視。例如以下圖：

三、在命令行工具中打開該項目src所在路徑，使用javadoc命令導出java文檔凝視。

命令例如以下：

> javadoc org/hbin/JavaDocTest.java

執行效果例如以下圖：

刷新項目。生成的文檔文件夾結構例如以下：

此時。文檔與源代碼混在一起。不便于管理維護。能夠加入-d參數來指定輸出文件的目標文件夾。

命令例如以下：

> javadoc -d ../doc org/hbin/JavaDocTest.java例如以下圖：

此時。打開項目中doc文件夾下的index.html文件就可以看到我們剛剛生成的文檔結構。例如以下圖：

四、參考以上三個步驟，你已經能夠生成自己的凝視文檔了。但假設你的凝視中包括中文或其它非英文字符，那么它可能會亂碼的。此時。能夠通過-charset和-encoding參數來指定編碼。-charset參數指定查看生成html的編碼，即在html文檔中加入<META http-equiv="Content-Type" content="text/html; charset=UTF-8">。而-encoding參數指定源文件編碼。

命令例如以下：

> javadoc -charset UTF-8 -encoding UTF-8 -d ../doc org/hbin/JavaDocTest.java

版權聲明：本文博主原創文章，博客，未經同意不得轉載。

總結

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

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