Javadoc 是 Sun 公司提供的一個技術，它從程序源代碼中抽取 類、方法、成員 等注釋形 成一個和源代碼配套的 API 幫助文檔。也就是說，只要在編寫程序時以一套特定的書寫注釋 的形式對代碼作注釋，在程序編寫完成后，通過 Javadoc 就可以同時形成程序的開發文檔 api 了。
開發者在二次開發中,通過查閱你寫的 api,就會對程序中某些自定義的方法或者整個代 碼的層次結構都會有很好的了解,對代碼的清晰閱讀起到很重要的作用， 而且有時候自己遺忘 了某些方法,也可以查閱此 api 文檔從而使自己更加清晰各種變量或者方法的意義。
對於以后的開發工作來說,規范 api 書寫，將是一個很好的編程習慣。 現在很多 IDE 都可以直接生成API文檔。
我們知道Java中有三種注釋語句：
1.//用於單行注釋。
2./*...*/用於多行注釋，從/*開始，到*/結束，不能嵌套。
3./**...*/則是為支持jdk工具javadoc.exe而特有的注釋語句。
javadoc工具能從java源文件中讀取/**...*/注釋，並能識別注釋中用@標識的一些特殊變量，制作成Html格式的類說明文檔，生成api文檔。
關鍵詞列表:
@author 作者名
@version 版本標識
@param 參數及其意義
@since 最早使用該方法/類/接口的JDK版本
@return 返回值
@throws 異常類及拋出條件
@deprecated 引起不推薦使用的警告
@see 參考類、方法、變量
@override 重寫
對於一個java類文件,我們需要四大塊javadoc注釋，便可生成api文檔
1.文件注釋
2.類注釋
3.屬性注釋
4.方法注釋
生成api文檔主流的有三種方法。
1.采用命令行窗口
2.采用eclipse生成
3.采用maven命令生成
參考文檔：