JavaDoc生成

JavaDoc

  • JavaDoc命令是用来生成自己API文档的
  • 注释文件可以写在类上面，也可以写在方法上面
  • 参数信息
  1. @author 作者名
  2. @version 版本号
  3. @since 指明需要最早使用的jdk版本号
  4. @param 参数名
  5. return 返回值情况
  6. @throws 异常抛出情况

  • 命令行生成参数文件：

    1. 右键class文件选择Show in Explorer，目录前加cmd打开命令行
    2. javadoc（java生成文档） -encoding UTF-8（编码为UTF-8） -charset UTF-8(字符集编码为UTF-8) 文件名.java

  • 然后在目录里找到index.heml打开

  • idea生成doc，首先点击tool，选择Generate JavaDoc，输出参数，选择生成范围，输出目录，区域选择zh-CN， 输入其它参数如：-encoding UTF-8 -charset UTF-8，ok生成

posted @ 2023-08-21 21:51  是葳蕤  阅读(7)  评论(0)  编辑  收藏  举报