JavaDoc生成的两种方法（doc命令和IDEA）

JavaDoc

包

为了更好的组织类，Java提供了包机制，用于区别名的命名空间

一般利用公司域名倒置作为包名； 例如:com.uzz

文档注释

/**
 * @author 作者名  **
 * @version 版本号 **
 * @since 指明需要最早使用的jdk版本
 * @param  参数名
 * @return 返回值情况
 * @throws 异常抛出情况
 * 
 */
 //放在类上面就是类的注释
 //放在方法上面就是方法注释

doc命令生成JavaDoc文档

1. 找到生成的java文件目录，输入cmd后回车

2.输入doc 命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

命令行格式一般为：javadoc 参数 Java文件

3.打开文件目录就可以了

使用IDEA生成JavaDoc文档

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

文档注释的一些内容可以向上翻，下面是代码部分：

/**
 * @author xiaolu
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     *@param  name
     * @return 返回值情况
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

 IDEA生成javadoc

1.

2.

第一步：选择生成JavaDoc文档的范围，我只对一个源文件生成Doc，所以选择文件。
第二步：输出目录最好新建一个文件夹，比较有条理和整洁
第三步：区域设置，决定文档的语言，简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
第四步：其他命令行参数：如果区域设置为中国，参数一般为-encoding UTF-8 -charset UTF-8
第五步：设置完成后点击确定即可生成Doc文档

3.查看JavaDoc文档

打开输出目录，就可看到成功生成，打开 index.html 便能看生成的文档。

 

点击跳转狂神说Java