java注解相关参数信息:
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
使用cmd 操作 javadoc命令行生成API 文档:
- 找到需要生成文档的代码文件位置 例如下:
- 跳转到cmd命令窗口 然后输入 javadoc -encoding UTF-8 -charset UTF-8 testss.java(后面接具体需要生成的java文件,我生成的是testss.java这个类)。
- 最后生成成功 会在你需要生成的文件的位置下生成如下代码,并点击index.html进入文档首页:
以上就是使用cmd命令成功生成API文档的操作。
第二种便是通过IDEA使用javadoc 生成javaAPI文档 :
点击IDEA菜单栏的Tools 再选中Generate Java Doc 在弹出的对话框进行如下操作:
1.
2.
3. 点击OK 之后会在控制台上输出生成文档的信息,如下:
4.生成成功之后会进行页面跳转到Java文档index首页。
以下便是IDEA如何使用javaDoc命令生成java文档的步骤。