Day05 Java的包机制，JavaDoc

七. Java的包机制

• 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。包的本质相当于文件夹，类比windows解决了同一文件夹不能存在同名文件的问题。

  语法：

  package pkg1[.pkg[.pkg3 ... ]];
  package java.util.lang
  

• 一般利用公司的域名倒置作为包名。

• 为了在程序中使用某一个包的成员，我们需要在Java程序中明确导入该包。使用import语句完成此功能。语法如下

  import package[.package2 ... ].(className | *)
  import java.util.Date;  //导入java.util的Data类
  import java.util.*;     //导入java.util下的所有类
  

八. JavaDoc

• javadoc命令用来生成自己的API文档。常用参数信息如下：

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

• 文档注释写在什么前面就是什么的注释，比如写在类前面就是类的注释，写在方法前面就是方法的注释。

  //一个类注释
  /**
   * @author konoha
   * @version 1.0
   * @since  1.8
   */
  public class JavaDoc {
      String name = "Konoha";
  
      //一个方法注释
      /**
       * 
       * @param name
       * @return Object String, class name
       * @throws Exception
       */
      public String getName(String name) throws Exception {
          return name;
      }
  }
  

• 在命令行下使用 javadoc 生成文档

  1. 找到需要生成文档的Java文件所在的文件夹。

  2. 在该文件夹下打开cmd窗口。

  3. 使用javadoc命令生成文档

     javadoc 参数 文件名
     

  javadoc的用法这里仅作简单了解，想要深入了解的可以自行查阅相关资料。