六包机制与JavaDoc

Posted 2021-08-11 &小小白&

一、包机制

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。
包语句的语句格式为：

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

一般使用公司域名倒置作为包名：例如（com.baidu.www）

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

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

二、JavaDoc

2.1、基本概念

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

参数信息

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

2.2、实现

2.2.1、先写好代码

package JavaDoc;

/**
 * @author xiaobai
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }

}

2.2.2、打开文件夹并打开命令行

1.打开所写代码的文件夹
2.在路径前面输入cmd并回车

2.2.3、输入命令

输入javadoc -encoding UTF-8 -charset UTF-8 +（你的class的名称）Doc.java

这里我的名称是Doc.java。

出现上述情况即为正常

2.2.4、打开index.html

先打开class所在文件夹

打开index.html

出现上述情况就完成了