JAVA Doc

• JAVA Doc 命令用来生成自己的 API 文档

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

  加在类上是类注释，加在方法上是方法注释

  /**
   * @author 叮当
   * @version 1.8
   * @since 1.8
   * ```
   */
  public class Demo_1 {
      String string_1;
      /**
       * @author 叮当
       * @param string_1
       * @return
       * @throws Exception
       */
      public String test(String string_1) throws Exception{
          return string_1;
      }
  }

  保存之后进入当前目录的 命令提示符(CMD) 窗口，键入 javadoc -encoding UTF-8 -charset UTF-8 *.java 输出的 index.html 文件是编写的 doc 文档

  如果提示 javadoc不是内部或外部命令，也不是可运行的程序或批处理文件。 需要自行到 path 中设置 jre java 的 ‘path’ 路径