JavaDoc

JavaDoc

• 用来生成自己API文档

• 参数信息

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

• package com.kuang.base;
  
  、、类注释
  /**
   * @author Kuangshen
   * @version 1.0
   * @since 1.8
   */
  public class Doc {
      String name;
      
  	、、方法的注释
      /**
       * @author Kuangshen
       * @param name
       * @return
       * @throws Exception
       */
      public String test(String name) throws Exception {
          return name;
      }
  }
  
  

  1. 通过命令行产生JavaDoc文档

  通过cmd进入该文档的路径下

  //产生javaDoc文档
  javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  

  

  

  2. 作业：使用idea产生JavaDoc文档，百度