java文檔注釋主要使用方法

一、java包含哪些注釋

1.//用於單行注釋。  

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

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

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

二、文檔注釋的關鍵名詞

    /**<p>標記         用於                                       作用</p>
     * @author        類或方法                                    一般用於描述開放者
     * @version       類                                         版本說明
     * @see           對類、屬性、方法的說明     　　　　　　　　　　  參考轉向，也就是相關主題 
     * @param         方法                                        對方法參數的說明
     * @throws        方法                                        對異常的說明
     * @return        方法                                        對返回值的說明
     * {@value}       方法，類 、屬性                              可以用於生成被標記的常量字段的值。
     * {@inheritDoc}  方法、類                                    可以集成上一個文檔的注釋
     * {@link}        類、方法                                    鏈接標簽
     * {@linkplain}   類、方法                                    鏈接標簽、與上一個標簽唯一的不同就是因為字體不同，如果 label 是個純文本，那就使用 linkplain 
     * @since         類、方法                                    表達的是被標記元素是哪個發布版本引入的
     * @exception     方法                                        跟@throws的用法相同   
     * @serialData
     * <pre>          方法、類                                    沒錯，這就是那個 HTML 標簽，用於顯示“原始樣子”的。
     */

三、一個例子

    public void aa(){
        
    }
    
    
    /**一般這幾個注解夠開放使用了
     * @author mingge
     * @since 1.0
     * @see #aa() 查看aa方法
     * @param a 參數a
     * @return  返回值描述
     * @throws 異常說明
     */
    public int test(int a) throws Exception{
        return a;
    }

我覺得很多細節還需要學習，天天學習，天天進步!

 

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