JAVA基础复习（二）

JavaDoc

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

• 加在类上面就是类的注释，加在方法上面就是方法的注释

• 参数信息

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

• 使用命令生成JavaDoc

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

  输出xml文档

• IDEA生成JavaDoc文件

  • 打开IDEA，找到Tools
  • 点击Generate JavaDOc
  • 按照如下要求修改
  • 注意点：
    • -encoding UTF-8 -charset UTF-8 -windowtitle "test"
    • -encoding是java代码编码，-charset是对生成文档所用的编码。-windowtitle就是对应html的