Java学习07：包机制&JavaDOC生成文档

包机制

介绍

• 包机制类似于文件夹，但是不完全等于文件夹。
  包语句的语法格式为：

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

一般使用公司域名倒置作为包名。com.cnblogs.www

导入包

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

使用"import"语句可完成此功能

例如，当你使用Date以后，会报错，是因为没有导入java自带的那个包

按住alt+enter可以自动排错，这时你可以点击想要导入的包，

上面就会写出“import java.util.Date"

import java.util.Date;
import com.baidu.www.*;//当你需要导入包下所有的类，可以写一个星号*

JavaDoc生成文档

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

文档注释

• 输入/**按回车后会直接生成文档注释,在类上面加或者在方法上面加是不一样的(后者会自动生成一些东西。)

package com.nekodream.base;

/**
 * @author NekoDream
 * @version 1.0
 * @since 1.5
 */
public class Doc {
    String name;

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

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

通过命令行（CMD）生成说明文档

• 进入CMD，在需要生成包的文件夹地址上输入javadoc，再空格，输入你想生成的类名。
• 为了防止乱码，可以再javadoc后面输入 -encoding UTF-8 - charset UTF-8

举个例子：
D:\java code\com\nekodream\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

通过IDEA生成javadoc文档

很简单。

• 工具-生成javadoc。