JavaDoc

简介

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

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

/*这是一个JavaDoc测试程序
@author Wang
@version 1.0
@since  1.16*/

public class JavaDoc {
    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 异常抛出情况

命令行生成Doc