生成JavaDoc文档
方式一:使用命令行生成JavaDoc
-
在资源管理器中打开想要生成的JavaDoc文档的.java文件目录
-
在地址栏起始位置输入cmd,回车
-
输入命令:
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
,回车
-encoding UTF-8 表示你的源代码(含有符合 JavaDoc 标准的注释)是基于 UTF-8 编码的,以免处理过程中出现中文等非英语字符乱码-charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码,目前所有浏览器都支持 UTF-8,这样最具有通用性,支持中文非常好
-
之后就可以看到生成后的JavaDoc文档
-
其中index.html即为生成的API文档,可在浏览器中打开
方式二:使用IDEA生成JavaDoc:
-
IDEA选择
Tools
->Generate JavaDoc
-
选择生成JavaDoc
第一步:选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件。
第二步:输出目录最好新建一个文件夹,比较有条理和整洁
第三步:区域设置,决定文档的语言,简体中文就是zh_CN、繁体(*)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
第四步:其他命令行参数:如果区域设置为中国,参数一般为-encoding UTF-8 -charset UTF-8
第五步:设置完成后点击确定即可生成Doc文档 -
IDEA会自动打开生成的API文档
-
查看JavaDoc文档
打开输出目录,就可看到成功生成,打开 index.html 便能看生成的文档。