JAVA学习05---包机制与JavaDoc

包机制

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

package pkg1[.pkg2[.pkg3...]];

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

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

JavaDoc

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

• 参数信息
  @author 作者名
  @version 版本号
  @since 指明需要最早使用的jdk版本
  @param 参数名
  @return 返回值情况
  @throws 异常抛出情况
• 生成javadoc文档
  (以下方demo为例)

package operator;

/**
 * @author SupervisorLU
 * @version 0.1
 * @since java1.8
 */

public class demo {
    public static void main(String[] args) {
    }
}

方法一：
1.在cmd命令行模式下打开该文件所在目录
2.输入javadoc -encoding UTF-8 -charset UTF-8 demo.java

3.运行成功后，文件夹下会多出几个html文件

方法二：
1.打开 idea并选择该文件，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。

2、进行配置：

标注的是重要的部分，从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。

这里的命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

-encoding utf-8 -charset utf-8
还可以配置那些注解需要生成，哪些权限类（private、package、protected、public）需要生成等等精细的控制。

还有一点需要注意，即不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误。

3、配置好后，点击生成按钮，生成好后就会自动在浏览器打开进行查看。
（注：方法二文档出自简书）

• 以下为官方文档
  java8官方api帮助文档