标签：ocs   title   输出   文件   api文档   code   参数   ble   idea   

如何使用Intellij Idea生成javaDoc文档

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

文档注释一般用以下形式来表示。

/**
*
*
*/

当然，其中可以加一些参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

接下来我用下面的代码来做一个演示：

package Homework;
?
/**
 * @author maoao
 * @version 1.0
 * @since 1.8
 */
public class BaseWork {
    public static void main(String[] args) {
        String a = "AabB";
?
        System.out.println(a);
        /**
         * @author maoao
         * @version 1.0
         */
?
    }
}
?

写好以后

1. 点击idea上面工具栏中的Tools - Gennrate JavaDoc

2. 进行一些必要的设置

• 最下面那行输入-encoding UTF-8 -charset UTF-8 -windowtitle "这里输入自己的装本java文件的文件夹名称" -link http://docs.oracle.com/java/8/docs/api/

特别注意：link 后面应是该版本idea的API文档地址！！！

然后就看到控制台输出了：

这样就成功了！！！

如何使用Intellij Idea生成javaDoc文档

标签：ocs   title   输出   文件   api文档   code   参数   ble   idea   

原文地址：https://www.cnblogs.com/maoao/p/14327054.html