1.简述

  • JavaDoc命令是用来生成自己的API文档的
  • 参数信息
    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param参数名
    • @return 返回值情况
    • @throws 异常抛出情况

2.示例

以上写到类里面就是类的注释,写到方法里面就是方法的注释

3.生成

进入类文件夹后在其地址栏前输入“cmd”将cmd命令提示符的现行地址指向类目录下,输入以下命令

javadoc -encoding UTF-8 -charset UTF-8 xxx.java

注:

  • -encoding参数设定代码编码
  • -charset 参数设置字符集编码

4.用IDEA生成JavaDoc文档


You got to put the past behind you before you can move on.