package Doc;

//javadoc命令是用來生成自己API文件的
/*引數資訊：
@author  作者名
@version  版本號
@since  指明需要最早使用的jdk版本
@param  引數名
@return  返回值情況
@throws  異常丟擲情況
 */
//jdk幫助文件：https://docs.oracle.com/javase/8/docs/api/

/**
 * @author mycm
 * @version 2.33
 * @since 1.8
 * 這裡是類的註釋
 */
public class Doc {

    //這是屬性
    String name;


    /*在下面的
        public String test (String name){
        return name;
    }輸入後
    然後在上面輸入  /**回車，會自動生成引數
     */

    /**
     * @author mycm
     * @param name
     * @return
     * @throws Exception
     * 這裡可以隨便寫，但是目前能夠通過方法自動生成引數的只知道param  return與throws Exception
     * 加在類上面的註釋就是類的註釋，加在方法上面的註釋就是方法的註釋
     * 這個就是方法的註釋
     */

    //這是方法
    public String test (String name)  throws Exception {   //Exception  翻譯:例外，規則的例外
        return name;


        /*通過開啟cmd，並轉到這個類的資料夾下  D:\桌面\Java程式碼學習\src\doc
        在裡面輸入javadoc -encoding UTF-8 -charset UTF-8 Doc.java
                          編碼     編碼格式  字符集
        為了能多顯示一些中文，解決亂碼問題
         */
        /*之後裡面多了一堆檔案，找到index.html檔案開啟
        就是java生成的文件

         /*使用IDEA生成doc文件
        在上方Tool中選中 Generate Javadoc
        最上面選中檔案來源，然後選中輸出地址
        最下面Locale 中填入zh_CN
        在Other command line arguments:中輸入-encoding UTF-8 -charset UTF-8

        說明:IntelliJ IDEA作為Java流行的編輯器, 其生成一些Javadoc會對中文亂碼, 使用UTF-8編碼即可. 這個常見的問題, 則需要生成時設定引數即可.
         傳入JavaDoc的引數，一般這樣寫 -encoding UTF-8 -charset UTF-8
         不然的話會報可能會報錯誤: 編碼GBK的不可對映字元
         */

    }
    }