02 Java基础语法（六）——包机制

六、包机制

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

定义： package pkg1[.pkg2.pkg3…]

一般利用公司域名倒置作为包名。com.baidu.www,com.baidu.baike

为了使用某一个包的成员，我们需要在Java程序中明确导入该包，使用import

导入： import package1[.package2].(classname!*)

包的本质就是文件夹

package com.song.base;

import java.util.Date;//import必须放在package下面

import com.song.base.*;//*导入这个包下所有类

public class Demo07 {

}

Javadoc

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

参数信息

@author 作者名

@version 版本号

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

@param 参数名

@return 返回值情况

@throes 异常抛出情况

package com.song.base;

/**
 * @version 1.0
 * @authon sj
 * @@since 1.8
 */

public class Doc {
    String name;

    /**
     * @param name
     * @return
     */

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

}

1.使用命令行生成JavaDoc文档

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

2.通过IDEA产生JavaDoc文档

（1）IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。

（2）点击上述菜单项后，会出现生成 JavaDoc 的对话框，一般的选项都很直观，不必细说。但是要注意生成 JavaDoc 的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 Project 为 JavaDoc 生成的源范围。

（3）里面有一个 Locale 可选填项，表示的是需要生成的 JavaDoc 以何种语言版本展示，根据 javadoc.exe 的帮助说明，这其实对应的就是 javadoc.exe 的 -locale 参数，如果不填，默认可能是英文或者是当前操作系统的语言，既然是国人，建议在此填写 zh_CN，这样生成的 JavaDoc 就是中文版本的，当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。

（4）还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

-encoding UTF-8 -charset UTF-8 -windowtitle “你的文档在浏览器窗口标题栏显示的内容” -link http://docs.oracle.com/javase/7/docs/api