JavaDoc
- javadoc命令是用来生成自己的APi文档
- 参数信息
- @author(作者名)
- @version(版本号)
- @since(致命需要最早使用的jdk版本)
- @param(参数名)
- @return(返回值情况)
- @throws(异常抛出情况)
用一段代码展示API的生成
package com.Java学不会.www;
/**
* @author Java学不会
* @version 1.0
* @since 1.8
*/
public class JavaDoc {
public void helloWord(){
System.out.println("HelloWorld");
}
}
一、 使用cmd命令行生成API
-
找到存放java文件的目录
![在这里插入图片描述](https://img-blog.csdnimg.cn/6e15230605304b13b04d309199735eec.png)
-
在当前目录打开命令提示符(cmd)
![在这里插入图片描述](https://img-blog.csdnimg.cn/a6718c75b0ed449189f1dd3b6ccd82d2.png)
-
输入命令:javadoc -encoding UTf-8 -charset UTF-8 Java文件名.java
![在这里插入图片描述](https://img-blog.csdnimg.cn/70385d9ada954f299d34f83dcf8ccf3d.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_34,color_FFFFFF,t_70,g_se,x_16)
-
等待生成完成以后在当前目录就可以看到生成的API
![在这里插入图片描述](https://img-blog.csdnimg.cn/66ca8f09787448c88ae2672b5f0714ff.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_9,color_FFFFFF,t_70,g_se,x_16)
-
打开index.html查看API
![在这里插入图片描述](https://img-blog.csdnimg.cn/854214d492334194a75dba6200c2ebd5.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_29,color_FFFFFF,t_70,g_se,x_16)
二、使用Intellij IDEA生成JavaDoc文档
![在这里插入图片描述](https://img-blog.csdnimg.cn/da69a7d57cb54813b79f9b84757d3582.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_13,color_FFFFFF,t_70,g_se,x_16)
![在这里插入图片描述](https://img-blog.csdnimg.cn/c5cdbfbcc9624ba8a0c5a2f016b74043.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_19,color_FFFFFF,t_70,g_se,x_16)
点击OK以后可以看到控制台正在生成
![在这里插入图片描述](https://img-blog.csdnimg.cn/395c4016b6cf490d8f9259d48ae33451.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_40,color_FFFFFF,t_70,g_se,x_16)
等待生成完成以后到目录去查看
![在这里插入图片描述](https://img-blog.csdnimg.cn/b03a181aa78146dd87d0855fa0ec8eb9.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_Q1NETiBASmF2YeWtpuS4jeS8mg==,size_23,color_FFFFFF,t_70,g_se,x_16)