idea 生成javadoc

Funny606

已于 2022-07-11 16:13:14 修改

阅读量189

点赞数

文章标签： intellij-idea java ide

于 2022-07-10 20:52:23 首次发布

本文链接：https://blog.csdn.net/Funny606/article/details/125710291

版权

Doc.java 文件

package com.zhang.base;
/**
 * @author Zhang ******
 * @version
 * @since 1.8
 */
//类的注释
public class Doc {
    String name;

//方法的注释
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

}

通过tools导航下的 generate JavaDoc
在这里插入图片描述
添加转换文件以及生成文件路径

在这里插入图片描述

然后点击index.html文档，查看API文档
在这里插入图片描述
API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。——百度百科