javaDoc
javadoc命令用于生成自己的API文档的
参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的JDK版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
生成Doc文件
命令行生成
选中class类文件 -> 右键show in explore ->cmd打开-输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java命令 ->index.html文件
IDEA生成
1.新建一个文件夹存储生成的Doc文档
2.Tools -> Generate JavaDoc ->在output directory中选择刚创建文件
3.接下来在底部的Locale输入框配置语言和编码集,如下图所示,语言用zh_CN,代表中文
-encoding utf-8 -charset utf-8
点击OK即可生成DOC文件。