包机制，创建包时，无论怎样都建在同一级，JavaDoc，IDEA如何配置JavaDoc文档

包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间
• 包语句的语法格式为：
• • package pkg1[.pkg2[.pkg…]];
• 一般利用公司域名倒置作为包名；www.baidu.com com.baidu.www
• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用“import”语句可以完成此功能
• • import package1【.package2…】.(classname|*);

创建包时，无论怎样都建在同一级

首先选中包，然后取消compact middle packages的勾选

JavaDoc

• javadoc命令是用来生成自己API文档的
• 参数信息
• • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

通过IDEA生成JavaDoc文档

首先规则：以//:开始，以///:~结束

package com.mao.base;
//:POI/ExportConfig
/**
 * @author Damao
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

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

    //作业：学会查找使用IDEA生成JavaDoc文档！
}///:~

看IDEA如何配置生成JavaDoc文档

• 

• 

• • 选择是整个项目还是模块还是单个文件文档输出路径

  • Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

  • 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api