JavaDoc生成文档

JavaDoc生成文档

• 添加文档注释

  • author 作者名

  • version 版本号

  • since 指明需要最早使用的jdk版本

  • param 参数名

  • return 返回值

  • throws 异常抛出情况

  package com.bxy.www;
  ​
  /**
   * @author  xiaoyu
   * @version 1.0
   * @since 1.8
   */
  public class Doc {
  ​
      String name;
  ​
      /**
       * @author  xiaoyu
       * @param name
       * @return
       * @throws Exception
       */
      public String test(String name) throws Exception{
          return  name;
      }
  ​
  }
  ​

• 使用doc命令生成文档

  在文件目录打开cmd窗口

  输入javadoc -encoding UTF-8 -charset UTF-8 文件名

以Doc.java示例

javadoc -encoding UTF-8 -charset UTF-8 Doc.java 回车

• 使用IDEA生成文档

  • 打开Tools > generate javaDoc

  • 选中File

  • 选择output directory 文件夹 选择输出位置

  • 填写Locale zh_CN

  • 填写Other command line arguments:-encoding UTF-8 -charset UTF-8 -windowtitlt "文档标题"

  • 点击OK