JavaDoc
-
javadoc命令是用来生成自己的API文档的
-
参数信息
-
@author 作者名
-
@version 版本号
-
@since 指明需要最早使用的jdk版本
-
@param 参数名
-
@return 返回值情况
-
@throws 异常抛出情况
-
E:\javadoc -encoding UTF-8 -charset UTF-8 Doc.java
在程序中写入文本注释后,可通过上述方法生成API文档,也可以使用IDEA内置的功能进行生成
使用javadoc命令,如果需要中文,则需要使用-encoding参数设置编码为UTF-8,使用-charset参数设置字符集为UTF-8,然后执行*.java文件
使用IDEA生成方法,选中需要生成doc的模块,选择Tools–Generate JavaDoc…–在Output directory中选择输出目录–在Other command line arguments:中设置编码(-encoding utf-8 -charset utf-8)–点击ok即可