包机制和JavaDoc

包机制和JavaDoc

包机制

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

• 包本质就是一个文件夹。

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

• 定义包用package,导入包用import。

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

JavaDoc

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

参数信息

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

package com.liu.base;
/**
 * @author  liuwenwen
 * @version 1.0
 * @since  1.8
 */
public class Doc {
    String name;   //属性

    /**
     * @author  liuwenwen
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{      //方法
        return name;
    }
}

命令行javadoc -encoding UTF-8 -charset UTF-8 Doc.java生成javadoc文档