JavaDoc

• JDK帮助文档

• javadoc命令是用来生成自己API文档的

• 参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的JDK版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

• 加在类之上 就是类注释

  加在方法之上 就是方法注释

• cmd命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

  [ javadoc 参数 Java文件]

  文件夹下生成很多文件，点击index.html主页打开文档

• IDEA生成的Doc文档方法：菜单栏 Tools -->Generate Java Doc.. -->设置文档生成的范围socpe -->输出路径