java基础12JavaDoc生成文档

JavaDoc生成文档

• javadoc命令是用来生成自己的API文档的
• 参数信息
  • @author作者名
  • @version版本号
  • @since指明需要最早使用的jdk版本
  • @param参数名
  • @return返回值情况
  • @throws异常抛出情况

1.可以加在类上，例如：

package com.abc.base;
/**
*@author  name  
*@version 1.0
*/
public class Doc{
   
}

2.也可以给方法加，例如：

package com.abc.base;

public class Doc{
   /**
*@param  name  
*@return
*@throws  Exception
*/
    public String test(String name){
        return name;
    }
}

命令行需执行操作：

假设：base包下的Doc.java存储地址为D:\A1\A2\com\abc\base

（PS：地址截止到最后一级包名）

则需要执行的操作：

​ 1.使用CMD打开该地址（D:\A1\A2\com\abc\base）

​ 2.在D:\A1\A2\com\abc\base>后输入如下代码后回车

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

//上述代码里的中间一串是为了防止注释网页打开时候出现文字乱码，实际上的生成代码只有javadoc Doc.java

​ 3.随后在D:\A1\A2\com\abc\base目录下就会生成一堆东西，其中index.html 就是生成的JavaDoc注释，直接打开就行

使用IDEA生成JavaDoc文档：

1. Tools -->Generate JavaDoc

2. 选择

   ①选择是整个项目还是模块还是单个文件（单个文件例如File'...\Doc.java'）

   ②在Output directory（输出目录）:后面的框内选择文档的输出路径

   ③在Locale（区域）：后面选择地区，决定文档的语言，中文就是zh_CN

   ④在Other command line arguments:（其他命令行参数）后面传入 JavaDoc参数，一般这样写就行： -encoding UTF-8 -charset UTF-8

3. 点击确定即可生成Doc文档（一般都叫index.html）

仅作了解：↓↓↓↓↓