009包机制和JavaDoc生成

包机制

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。包的本质就是文件夹。

包语句的语法格式为：

package pkg1[.pkg2[.pkg3…]]；

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

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

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

package必须在import上面，尽量不要让包里面的名字重复。

导入这个包下所有的类，在后面加 .*

import com.kuang.base.*;

JavaDoc

javadoc命令是用来生成自己API文档的，即帮助文档

JDK帮助文档可以从官网下载

参数信息

@author 作者名

@version 版本号

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

@param 参数名

@return 返回值情况

@throws 异常抛出情况

加在类上面就是类的注释，加在方法上面就是方法的注释。

package operation;

/**
 * @author ShaoYang
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author ShaoYang
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
        //命令行生成  javadoc 参数 Java文件 >javadoc -encoding UTF-8 -charset UFT-8 Doc.java
        //学会查找使用IDEA生成JavaDoc文档
    }
}

如何使用IDEA生成JavaDoc文档