java基础08-包机制及JavaDoc生成文档

java基础08-包机制及JavaDoc生成文档

一、包机制

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

(包的本质就是文件夹)

包语句的语法格式为：

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

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

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

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

二、JavaDoc生成文档

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

https://docs.oracle.com/javase/8/index.html

参数信息：

@author 作者名

@version 版本号

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

@param 参数名

@return 返回值情况

@throws 异常抛出情况

package operator;
/**
 * @author XiaoCai
 * @version 1.0
 * @since 1.8
 */
public class demo07 {
    String name;

    /**
     * @author XiaoCai
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

操做方法：
1.在该类上右键点击 Show in Explorer进入文件位置

2.直接在地址栏前加cmd ，进入命令行

3.输入命令：javadoc -encoding UTF-8 -charset UTF-8 demo07.java

（-encoding UTF-8 -charset UTF-8:避免中文乱码）（demo07.java需要生成文档的类）

4.在生成的 index.html文件当中可以进行查看