JavaDoc生成文档
javados命令是用来生成自己API文档的
参数信息:
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
-
利用命令行窗口生成API文档:
-
右击Doc -----> 点击 Open In Explorer找到文档所在位置
-
在打开路径页面上选中路径，输入cmd+回车
-
输入命令:javadoc 参数 java文件
例:javadoc -encoding UTF-8 -charset UTF-8 Doc.java
-
返回原文件夹,找到index.html(主页),双击就会生成文档
-
-
使用IDEA生成javadoc文档:
-
（选中要生成文档的类）找到工具栏tools --> Gencrate JavaDoc…打开
-
在弹出的窗口主要进行三步
- 第一步：点击第三个：文档所在的位置
-
第二步：输入语言环境为中文：zn_CN
-
第三步：输入命令行参数: -encoding UTF-8 -charset UTF-8
-
然后点击Generate（生成）生成文档
-
返回原文件夹,找到index.html(主页),双击就会生成文档
-