Java基础07:包机制和JavaDoc生成文档

包机制

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

package 包名;

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

import 包名;

JavaDoc生成文档

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

• 参数信息

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

package com.longhai.base;

/**
 * @author lkk
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

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

此类所在的资源管理器下输入cmd并打开

javadoc -encoding UTF-8 -charset UTF-8 类名.后缀名

然后出现

发现目录下多了很多东西

直接打开index.html

通过IDEA生成javadoc

1. 选择是整个项目还是模块还是单个文件

2. 文档输出路径

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

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