12-包机制与JavaDoc

包机制与JavaDoc

包机制

 

  • 为了更好地组织类，java提供了包机制，用于区别类名的命名空间。

  • 包语句的语法格式为

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

     

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

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

  •  
    1 import package1[ .package2...].(classname|*);
2  import com.xiaoka.base.*;
3  //  *为通配符：导入这个包下所有的类

     

JavaDoc

  • javadoc命令是用来生成自己API文档的（https://docs.oracle.com/javase/8/docs/api/）

  • 参数信息

    • @author 作者名

    • @version 版本号

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

    • @param 参数名

    • @return 返回值情况

    • @throws 异常抛出情况

  •  1  package com.xiaoka.base;
 2  ​
 3  /**
 4   * @author xiaoka
 5   * @version 1.0
 6   * @since 1.5
 7   */
 8  public class Doc {
 9  ​
10      String name;
11  ​
12      /**
13       * @author xiaoka
14       * @param name
15       * @return
16       * @throws Exception
17       */
18      public String test(String name) throws Exception{
19          return name;
20      }
21      
22      // 百度搜素如何使用IDEA生产JavaDoc文档     面向百度编程
23      // 基础知识很重要
24  }
25

     

posted @ 2021-03-20 12:51  小carlos  阅读(38)  评论(0)    收藏  举报