JavaDoc开发文档

2021-09-22 05:55:10

JavaDoc是一种将注释生成HTML的技术，生成的HTML文档类似于Java的API，易读且清晰明了。

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过 Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的

/**
 * 这是一个Javadoc测试程序
 *
 * @author hello_12153
 * @version 1.0
 * @since 1.5
 */
public class HelloWorld {
    public String name;

    /**
     * @param name 姓名
     * @return 返回name姓名
     * @throws Exception 无异常抛出
     */
    public String function(String name) throws Exception {
        return name;
    }

}

以 /* 开始，以 / 结束。

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

1.DOS命令生成DOC

DOS控制台中，切换到Java源文件的工作目录下，输入指令javadoc xxx.java，生成API文档，打开index.html查看即可

一般会加上-encoding UTF-8 -charset UTF-8 解决GBK乱码问题，在中间添加编码设置

javadoc -encoding UTF-8 -charset UTF-8 HelloWorld.java

2.IDEA生成Doc

新建一个文件夹，用于存放要生成的Javadoc文档
点击 Tools-> Generate JavaDoc，这样会弹出生成JavaDoc文档的配置页面
在弹出的界面中配置相关信息

![Generate JavaDoc (2)](L:\博客园_hello_12153\简单基础语法\Generate JavaDoc.png)
在目录中打开index.html查看即可

码农公寓

1.DOS命令生成DOC

2.IDEA生成Doc

相关文章