java文檔註釋主要使用方法

1、java包含哪些註釋

1.//用於單行註釋。  

2./*...*/用於多行註釋，從/*開始，到*/結束，不能嵌套。  

3./**...*/則是爲支持jdk工具javadoc.exe而特有的註釋語句。這個也就是咱們所知的文檔註釋

在命名控制檯:使用命令行在目標文件所在目錄輸入javadoc +文件名.java。

2、文檔註釋的關鍵名詞

    /**<p>標記         用於                                       做用</p>
     * @author        類或方法                                    通常用於描述開放者
     * @version       類                                         版本說明
     * @see           對類、屬性、方法的說明     　　　　　　　　　　  參考轉向，也就是相關主題 
     * @param         方法                                        對方法參數的說明
     * @throws        方法                                        對異常的說明
     * @return        方法                                        對返回值的說明
     * {@value}       方法，類 、屬性                              能夠用於生成被標記的常量字段的值。
     * {@inheritDoc}  方法、類                                    能夠集成上一個文檔的註釋
     * {@link}        類、方法                                    連接標籤
     * {@linkplain}   類、方法                                    連接標籤、與上一個標籤惟一的不一樣就是由於字體不一樣，若是 label 是個純文本，那就使用 linkplain 
     * @since         類、方法                                    表達的是被標記元素是哪一個發佈版本引入的
     * @exception     方法                                        跟@throws的用法相同   
     * @serialData
     * <pre>          方法、類                                    沒錯，這就是那個 HTML 標籤，用於顯示「原始樣子」的。
     */

3、一個例子

 1     public void aa(){
 2         
 3     }
 4     
 5     
 6     /**通常這幾個註解夠開放使用了
 7      * @author mingge
 8      * @since 1.0
 9      * @see #aa() 查看aa方法
10      * @param a 參數a
11      * @return  返回值描述
12      * @throws 異常說明
13      */
14     public int test(int a) throws Exception{
15         return a;
16     }

我以爲不少細節還須要學習，每天學習，每天進步!

 

參考:https://hacpai.com/article/1402537988442