一、名詞解釋

javadoc是從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標簽作注釋，在程序編寫完成后，通過Javadoc就可以同時形成程序的開發文檔了。
javadoc命令是用來生成自己API文檔的，使用方式：使用命令行在目標文件所在目錄輸入javadoc +文件名.java。
簡單的來說，就是在Java中寫注釋，然后形成開發文檔。Javadoc用于描述類或者方法的作用，可以寫在類上面和方法上面。
https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

二、寫在類上

1. @link：{@link 包名.類名#方法名(參數類型)} 用于快速鏈接到相關代碼
使用此文檔標記的類或者方法，可用通過按住Ctrl鍵+單擊 可以快速跳到相應的類或者方法上，解析成html其實就是使用< code> 包名.類名#方法名(參數類型)< /code>
2. @code： {@code text} 將文本標記為code
將文本標記為代碼樣式的文本，在code內部可以使用 < 、> 等不會被解釋成html標簽, code標簽有自己的樣式一般在Javadoc中只要涉及到類名或者方法名，都需要使用@code進行標記。
3. @param
一般類中支持泛型時會通過@param來解釋泛型的類型
4. @author
詳細描述后面一般使用@author來標記作者，如果一個文件有多個作者來維護就標記多個@author，@author 后面可以跟作者姓名(也可以附帶郵箱地址)、組織名稱(也可以附帶組織官網地址)
5. @see
@see 一般用于標記該類相關聯的類,@see即可以用在類上，也可以用在方法上。
6. @since 從以下版本開始
@since 一般用于標記文件創建時項目當時對應的版本，一般后面跟版本號，也可以跟是一個時間，表示文件當前創建的時間
7. @version 版本
@version 用于標記當前版本，默認為1.0

三、寫在方法上

1. @param
@param 后面跟參數名，再跟參數描述
2. @return
@return 跟返回值的描述
3. @throws
@throws 跟異常類型 異常描述 , 用于描述方法內部可能拋出的異常
4. @exception
用于描述方法簽名throws對應的異常
5. @see
@see既可以用來類上也可以用在方法上，表示可以參考的類或者方法
6. @value
用于標注在常量上，{@value} 用于表示常量的值
7. @inheritDoc
@inheritDoc用于注解在重寫方法或者子類上，用于繼承父類中的Javadoc

引用：https://blog.csdn.net/vbirdbest/article/details/80296136

總結

以上是生活随笔為你收集整理的【Java】Javadoc的使用的全部內容，希望文章能夠幫你解決所遇到的問題。

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