Study08：包机制与Java Doc

包机制

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

• 可以将包看成电脑里的文件夹

• 包机制的语法格式为：

  package pkg1[.pkg2[.pkg3……]
  

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

• 域名为：www.yidai.com 包可为：com.yidai.www

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

  import package1[.package2……].(classname|*)
  

//导入包下所有的类
import com.yidai.*;

Java Doc

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

JDK文档链接如下：

API文档

参数信息如下：

/**
 * @author Yidai            （作者名）
 * @version 1.0             （版本号）
 * @since 1.8               （指明需要最早使用的jdk版本）
 */
//类的注释
public class Doc {

    String name;

    /**
     * @author Yidai
     * @param name          （参数名）
     * @return              （返回值情况）
     * @throws Exception    （异常抛出情况）
     */
    //方法的注释
    public String test(String name) throws  Exception{
        return name;
    }

    //通过命令行     javadoc  参数   java文档

    //学会查找使用IDEA生产JavaDoc文档

1. 通过命令行生成JavaDoc文档
2. 通过IDEA生成JavaDoc文档