JavaDoc生成文档
JavaDoc生成文档
- Javadoc命令是用来生成自已API文档的
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
CMD: javadoc -encoding UTF-8 -charset UTF-8 Doc.java
生成文档
方法1
-
在我的电脑找到java文件夹，然后在地址栏最前面加上空格再输入cmd
-
打开cmd 输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java
-
当前文件夹就会生成很多文件，打开index.hetm查看
方法2
IntelliJ IDEA 中生成
-
点击tools在点击Generate JavaDoc
-
红圈的地方要注意选择和填写一下。