基础语法04：包机制和JavaDoc

#1. 包机制

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

• 包语句的语法格式

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

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

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

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

#2. JavaDoc

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

• 参数信息

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

• 代码示例：

package com.tianyu.Base;
/**
* @author 作者
* @version 1.0
* @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author 作者
     * @param 
     * @return 返回值情况
     * @throws Exception  //抛出异常
     */
    public String test(String name) throws Exception{
        return name;
    }
}

• 命令行执行

  • javadoc 参数 Java文件

  • 命令行执行
    

  • 运行结果
    

  • 帮助文档页面
    

、