JavaDoc生成文档
示例代码
package www.java.demo;
/**
* @author li
* @version 1.0
* @since 1.0
*/
public class Doc {
String name;
/**
* @author li
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
加在类上面就是类注释,加在方法上面就是方法注释
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
命令行生成文档的命令
命令行生成文档
首先通过这个进入该类的所在文件夹
我们可以看到这个文件夹中只有Doc.java这一个java文件
通过在该类根目录前面添加cmd+空格 回车打开cmd直接进入这个目录下的cmd
利用Javadoc命令来生成文档
encoding:编码的意思,让编码变成UTF-8的格式
charset:字符集编码 让字符集也变成UTF-8 的格式
因为代码中有包 package,会报错和警告,但是不影响。
如下结果就说明文档生成成功
这时我们会发现多了很多文件,找到其中的index.html文件并打开。
打开后我们就会发现生成好的文档了。
点进去这个Doc包,可以看到我们写的注释
idea生成文档
点击Tools–>Generate JavaDoc
选择是整个项目还是单个文件,在这里选择单个文件
文档输出路径
地区选择中国,输出的语言就是中文
-encoding UTF-8 -charset UTF-8 让编码和字符集转为UTF-8的格式,防止出现乱码。
控制台显示以上类容说明生成代码成功,然后会自动跳转到网页,打开生成的代码,我们也可以找到保存文档的文件夹