JavaDoc文档生成详细操作

JavaDoc练习

JavaDoc是一种将注释生成HTML文档的技术,是用来生成自己API文档的.

参数信息

/*
@author 作者名
@version 版本号
@since  知名最早需要使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
 */

示例代码

package com.lic.base;
//JavaDoc
/**
 * @author lic
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
    /**
     * @author lic
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception {
        return name;
    }
}

1. 通过命令行产生JavaDoc文档

1.用文件夹打开 Doc命令执行操作此文件夹



2.点击自动生成的index.html



3.会跳转到java生成的文档



4.点进所写的Doc类



2. 通过IDEA产生JavaDoc文档

1.打开IDEA 找生成JavaDoc



2.参数配置



3.成功生成JavaDoc文档