526互联

Java学习之路--javadoc

发布时间 2023-09-20 13:49:50作者: 寂灭无言
package com.chao.base;

/**
 * @author  chao    (author,作者名)
 * @version  1.0    (version,版本号)
 * @since 1.8       (since指名需要最早使用的jdk版本）
 */
public class Doc {
    String name;

    /**
     * @author  chao
     * @param name  (param,参数名)
     * @return  (返回值情况)
     * @throws Exception    (异常抛出情况)
     */
    //javadoc 参数（可不要）java文件
    /*
    法1.命令行生成JavaDoc文档
    进入存放java.class的文件夹，右键单击-->OpenIn-->Explorer
    路径栏输入：cmd 空格，回车打开了在当前路径下的命令提示符，输入生成JavaDoc命令
    javadoc encoding UTF-8 charset UTF-8 Doc.java,回车即可
    法2.IDEA生成JavaDoc文档
    操作步骤：
    1.点Tools-->Generate JavaDoc
    2.选择整个项目生成，还是单个文件
    3.Output directory（文档生成输出的路径）
    4.Locale 选择地区，决定了文档的语言，中文就写zh_CN
    5.Other command line arguments,输入-encoding UTF-8 -charset UTF-8
    6.最后点击确定就行
    */
    public String test(String name) throws  Exception{
        return name;
    }
}