Java基础12：JavaDoc生成文档

Java基础12：JavaDoc生成文档

javadoc命令是用来生成自己API文档的

参数信息：

1. @author 作者名
2. @version 版本号
3. @since 指明需要最早使用的jdk版本
4. @param 参数名
5. @return 返回值情况
6. @throws 异常抛出情况

代码部分：

package com.pzz.base;

/**
 * @author PZZ
 * @version  1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author PZZ
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }

    //作业：学会查找使用IDEA生成JavaDoc文档！  面向百度编程
    
    //基础部分的一切知识，后面几乎每天都会用
}

用IDEA生成javadoc文档：https://blog.csdn.net/weixin_42140580/article/details/89635775

步骤：

1. 选择整个项目还是模块还是单个文件
2. 文档输出路径
3. Locale选择地区，这个决定了文档的语言，中文就是zh_CN
4. 传入JavaDoc的参数，一般这样写-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api