JavaDoc

JavaDoc

jdk帮助文档地址

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

• 参数信息

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

• 类注释：

  放在类前的文档注释（/** 注释内容 */）

  package cheng.com.base;
  
  /**
   * 1、可以放在类前（类注释）
   * @author guanCheng
   * @version 1.0
   * @since 1.8
   */
  public class Doc {
      
  }
  

• 方法注释：

  放在方法前的注释（/** 注释内容 */）

  String name;
  
  /**
       * 2、可以放在方法前（方法注释）
       * @param name
       * @return
       * @throws Exception
       */
  public  String showInfo(String name) throws Exception {
      return name;
  }
  

• 使用命令行生成文档：javadoc 参数 Java文件

  1. 进入目标文件所在的文件夹
     

  2. 进入doc操作界面

  

  3. 输入javadoc命令

  

  4. 打开生成的 index.heml 页面

     

  5. 点击打开文档

  

  6. 文档效果