Doc

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的不可映射字符
         */

    }
    }