JavaDoc

JavaDoc

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

• 参数信息：

  • @author作者名

  • @version版本号

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

  • @param参数名

  • @return返回值情况

  • @throws 异常抛出情况

• package com.wang.base;
  
  //类注释
  /**
   * @author zhizhi
   * @version 1.0
   * @since 11
   */
  public class Doc {
      String name;
  
      //方法注释
      /**
       * @author zhizhi
       * @param name
       * @return
       * @throws Exception
       */
      public String test(String name) throws Exception{
          return name;
  
          //命令行生成JavaDoc文档 命令格式： javadoc 参数 Xxx.java
          //javadoc -encoding UTF-8 -charset UTF-8 Doc.java
          //怎么使用IDEA生成JavaDoc文档？
      }
  
  }
  

[点击跳转](使用IDEA生成JavaDoc文档（IDEA2020.3.2）_Gyur Miyonesqn的博客-CSDN博客)