javaDoc文件生成

今天呢，我們的java基礎已經學到底部了，我們回憶最開始學到註釋中的文件註釋，是不是給大家留了個懸念，要在javaDoc中詳細講解

那我們今天就看看什麼是javaDoc，

javaDoc命令是用來生成自己API文件的

API幫助文件

javadoc是一種技術，可以將註釋資訊生成一個幫助文件，就是類似於java的API，

大家是不是不知道API長什麼樣子，那我們開啟瀏覽器，百度搜尋：jdk幫助文件，找到Oracle官網

點進去就可以看到有很多版本，我們可以選擇自己的版本，當然也可以看最新的版本，這個隨意，我就直接選擇API8了

進去以後就可以看到非常非常多的API幫助文件，記住這個網址以後可能會經常用到，不過我們也沒必要全部學會，只要學會重點的，有用的

文件大概就長這麼個樣子，我們以後會用到，但是今天不用，就先把他關掉

javaDoc

我們這個javadoc命令也是用來生成這個API文件的，這個就是生成一個自己的類的，跟文件註釋相關的，看下來的引數，作者名，版本號，引數名等等

那我們進IDEA寫一個簡單的類，在base裡建立一個class，名為Doc，

我們這個類就叫Doc，然後給它加個文件註釋，文件註釋的格式是：*/* 回車，右斜槓加兩個星號加回車

按照格式先寫個作者名：@author，一下就出來了，還有個下劃線，再加個版本號：@version，可以叫做1.0版本，還有需要的jdk版本：@since，寫上對應的版本我是jdk1.8的版本就寫1.8

這是寫在類上的，還可以寫在方法上，比如說我們可以定義一個類變數，再寫個方法，main方法大家都知道，就不用這個方法了，換一個test

public static void main(String[] args) {}
//main方法就不用了
public String test(String name){
    return name;
}

這個方法大家看不懂，但我們以後會學到，要知道這是個方法，那我們來寫一下，註釋，上面是給類註釋的，這裡是可以給方法註釋的，

我們寫一下注釋，右斜槓加兩個星號加回車，你一按下回車它就自動生成引數，

那我們在看一下更多的操作，把原來的註釋刪掉，然後在方法後面加上

throws Exception

然後下“槓星星”回車

可以看到他就生成了throws，說這個方法會丟擲異常，這些都是可以進行一些修改的，當然你也可以在上面加上作者名之類的

這個文件，它能寫的都在這個圖裡面，

這些不多吧，也不難，但是大家都看不懂，我們只需要寫一個作者名和版本號就行了，其他的我們現在用的也比較少，萬一需要用到的話，也是很簡單的，

只要知道，加在類上面的是類註釋，加在方法上面的是方法註釋，這能理解吧

但是有人會問了，這個文件註釋和普通註釋也沒什麼區別呀，那就給你看一下它的區別，我們先找到這個檔案的地址，右鍵該檔案，選擇Show in Explorer

開啟資料夾以後，我們可以看到很多我們建立的java資料夾，

那我們再用命令列開啟，也就是cmd，之前學過，怎麼在命令列開啟cmd，是不是在前面加個cmd空格就可以了

到cmd以後呢，我們要輸一個命令，我們之前是不是學過java和javac的命令，

現在再教大家一個：javadoc，什麼意思呢，就是java生成文件，但是，我們的java檔案裡面是不是有中文呀，那我們再加一條命令：-encoding UTF-8，什麼意思呢，就是編碼的意思，再讓他的字符集也變成中文，再輸入：charset UTF-8，

javadoc -encoding UTF-8 charset UTF-8

這條命令，javadoc是java命令，然後加了兩個引數，這兩個引數是為了能讓他儘量顯示中文，儘量少出現亂碼的情況

那我們後面再輸入檔名，是不是叫：Doc.java，

那我們直接這樣去執行，看一下會不會出現問題

可以看到，它生成了一些警告，不管他們，依舊是成功輸出了，

可以看到，它生成了很多html的東西，那我們去檔案裡看一下，

在檔案裡是不是多出了很多檔案吶，其他的不管，我們可以找到叫：index.html的檔案，這個index就是首頁的意思，我們點進去看一下

進去的網頁是不是跟剛才看到的API幫助文件的介面一模一樣，只是很乾淨，只有程式包和類，那我們點進這個doc的類，進去看一下

是不是可以看到我們剛才寫的一些內容，什麼方法，版本，一些東西我們還沒學過，都看不懂，但是，這個文件是給我們生成了，而且還非常的詳細

這就是用我們的命令列，cmd，生成的這就是javadoc

---

作業：學會查詢使用IDEA生成javadoc文件

今天是用命令列生成javadoc，而作業呢，是用IDEA生成，在百度上有非常多的方法，自己去搜