Java 包机制、JavaDoc

包机制

• 为了更好地组织类，Java提供了包机制，用于区别类地命名空间。
• 包语句地语法格式如下

package pkg1[.pkg2[.pag3...]];

• 一般公司利用公司地域名倒置作为包名
• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用import语句即可完成此功能

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

• 通配符 * 导入一个包的所有内容

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

JavaDoc

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

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

package com.kuang.base;
/**
 * @author sanduo
 * @version 1.0
 * @since 1.8
 * */
public class Doc {
    String name;

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

• 命令行生成

javadoc -encoding UTF-8 -charset UTF-8 Doc.java(这里的Doc.java是文件)