Javadoc

Javadoc （ 最初是JavaDoc ） 是由Sun Microsystems爲Java語言 （ 現在由甲骨文公司擁有 ） 創建的文檔生成器 ， 用於從Java源代碼生成HTML格式的API文檔 ， HTML格式用於增加將相關文檔鏈接在一起的便利性 。 Javadoc使用的 “ doc comments ” 格式 是記錄Java類的事實上的行業標準 。 一些IDE ， 如IntelliJ IDEA 、 NetBeans和Eclipse ， 可以自動生成Javadoc HTML 。 許多文件編輯器幫助用戶生成Javadoc源代碼並使用Javadoc信息作爲程序員的內部引用 。 Javadoc還提供了用於創建doclet和taglet的API ， 允許用戶分析Java應用程序的結構 ， 這就是JDiff如何生成兩個API版本之間發生變化的報告 。 Javadoc不影響Java中的性能 ， 因爲在編譯時會刪除所有註釋 。 編寫註釋和Javadoc是爲了更好地理解代碼 ， 從而更好地維護代碼 。