java包机制、JavaDoc

6.包机制、JavaDoc

1. 包机制

   • 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间(其本质是文件夹)

   • 包的声明必须在有效代码的第一行

   • 包语句的语法格式为

     • package pkg1[.pkg2[.pkg3...]];
       

   • 一般使用公司域名倒置作为包名；

   • 为了能够使用某一个包的成员，我们需要在Java中导入该包,使用"import"语句导入。

     • 导入的包尽量避免包里面的名字重复

     • import package1[.package2...].(classname|*); //*是通配符，意导入该包下的所有类
       

​ 阿里巴巴开发手册

2. JavaDoc

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

   • 参数信息

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

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

     /**
      * @author wang
      * @version 1.0
      * @since 1.8
      */
     public class doc {
         String name;
     
         /**
          * @author wang
          * @param name
          * @return null
          * @throws Exception
          */
         public String test(String name) throws Exception{
             return name;
         }
     }
     

     ---

   • 通过命令行生成API文档

     跳转到.java所在的地址，命令行模式输入如下命令：

     //java命令     参数设置使用UTF8字符集      Java文件
     javadoc -encoding UTF-8 -charset UTF-8 Doc.java