包机制与JavaDoc指令

包机制

包机制的目的是为了更好的组织类，用于却别类名的命名空间。通常命名采取公司域名的倒置的方式，例如：com.tencent.xxx等。

包语句的语法格式为：

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

导入包的语法格式为：

import pkg1[.pkg2...(classname|*);

如下例所示：

package java.grammar;

import java.util.Date;//若没有此语句，Date参数会报错

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

}

当导入包后类名为*时，会导入该包种的所有类。

---

JavaDoc命令

javadoc命令能将自己程序的文档注释生成为自己的API文档。

文档注释有以下几类：
@author 作者名

@version 版本号

@since 指明需要最早的JDK版本

@param 参数名

@return 返回值的情况

@throws 异常抛出情况

cmd命令生成API文档

通过打开cmd命令栏后输入javadoc -encoding UTF-8 -charset UTF-8 文件名.java（不理解什么意思）后，路径下会出现一个index.html的文件，进入即可查看。

如下图所示：

进入路径下出现即可进入下图网页，即API文档。

IDEA中生成API文档

进入菜单栏中的Tools-Generate JavaDoc 进入如下页面：

​ （图片转载至https://www.cnblogs.com/papercy/p/14333406.html）

后续同上方法。

---

强力推荐！本文学习教程网址https://www.kuangstudy.com/