Java06-包机制&JavaDoc文档

包机制

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间（等同于文件夹）

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

eg:com.baidu.www（会生成树状子目录）

包语句的格式：package package1[.package2[.package3]]

如果没有生成树状子目录，可取消如图勾选

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

import com.kuang.base.*****:表示通配符，导入这个包下所有的类

JavaDoc生成文档

参数信息

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

package com.kuangstudy.base;
/**
 * @author Jodie
 * @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;
    }
    //通过命令行执行：javadoc (-encoding UTF-8 -charset UTF-8) java文件    中间参数是为了让界面中文更好显示
    //作业：学会查找使用IDEA生成JavaDoc文档！！！   面向百度编程！！！
}

使用IDEA生成JavaDoc文档

1. 选择或新建一个存放javaDoc文档的文件夹

2. 点击IDEA顶部Tools菜单

3. 配置

• 第一栏是选择是针对整个项目，还是单块文件等的文档

• output directory:选择放的位置
• Locale：选择地区，配置语言。中文文档：zh_CN
• other command line argument:配置编码集：-encoding utf-8 -charset utf-8

3. 点击OK生成文档
4. 打开JavaDoc文件夹，点击index.html可以看到API文档。