两种方法生成java帮助文档（控制台和IDEA，Javadoc）

JavaDoc

• javadoc命令是用来生成自己的API文档的

参数信息

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param 参数名
• @return 返回情况
• @throws 异常跑出情况

示例程序

/**
 * @author :Jeffery
 * @version :1.0
 * @since 1.8


 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String testO(String name)throws Exception{
        return name;
    }
}

在不同的位置书写可以生成类和方法的帮助文档

当我们在类中声明了这些之后，我们就可以生成我们的帮助文档。

首先便是通过命令行指令生成

1. 在类(.java)所在文件夹打开控制台

2. 输入Javadoc命令，因为我们的文档带有中文，所以我们要指定我们的编码为UTF-8

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

3. 回车，开始执行

4. 成功生成了很多文件
   

5. 我们打开index.html
   

6. 熟悉的API帮助文档界面

然后便是通过IDEA生成

1. 我们在合适的地方新建一个文件夹准备存储我们的帮助文档

2. 接下来点击IntelliJIDEA顶部的Tools菜单，选择GenerateJavaDoc选项

3. 然后在弹出的界面中我们点击Outputdirectory输入框后面的按钮，在弹出的选择文件夹界面中选择刚才新建的文件夹，

4. 接下来在底部的Locale输入框配置语言和编码集，语言用zh_CN，代表中文，其他的输出和控制塔一致

5. 然后点击OK以后我们就等待IntelliJIDEA给我们生成JavaDoc文档即可，等到输出栏出现的提示代表生成完毕

6. 接下来我们打开我们之前所建的文件夹，找到index.html文件，点击它

7. 最后我们就可以看到的JavaDoc文档了

   
   如果大家有想指正的欢迎在评论区告诉我。