• JavaDoc
  • 1、简介
  • 2、命令行生成Doc

JavaDoc

1、简介

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。 在简略介绍JavaDoc写法之后，再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

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

先看一段样例代码：

/**
 * 这是一个Javadoc测试程序
 *
 * @author Kuangshen
 * @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 异常抛出情况

2、命令行生成Doc

打开cmd

切换到文件当前目录 cd /d E:\java\study\package\test

输入指令： javadoc HelloWorld.java

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

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

之后会多出一堆文件，打开index.html查看