标签：Java name 32 JavaDoc 生成 API return throws String
- javadoc命令是用来生成自己API文档的
- 参数信息：
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的JDK版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
- 比如这就是一个JDK 21的Oracle官方API：点击跳转
package acolyte.operator;
/**
* 这是加在类上的doc
* @author acolyte
* @version 1.0
* @since 21
*/
public class Doc {
String name;
/**
* 这是加在方法上的doc
* @author acolyte
* @param name//参属、返回、抛出都是自动生成的
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;//这里只是举个例子，完全看不懂是些啥
}
}
- 完成上述代码后，找到这个名为“Doc”的类的目录，进入CMD，输入以下命令生成API。
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
（虽然会有一堆报错，但是不要介意，这只是演示下步骤。）
- 目录中会多出来一堆文件，找到index.html打开，就会发现生成了和Oracle官方界面差不多的API网页。（虽然没什么内容）
- 在IDEA里，可以从菜单栏里找到“Tools”下的“Generate JavaDoc”指令，设置好一些参属之后就能生成API了。
- 最新版的IDEA找不到Tools菜单，可以将UI切回传统版。（让我找找怎么切回去……）
标签：Java,
name,
32,
JavaDoc,
生成,
API,
return,
throws,
String
From： https://www.cnblogs.com/Acolyte/p/17831941.html