包机制和JavaDoc文档

包机制

为了更好的组织类，Java提供了包机制（类似于文件夹功能），用于区别类名的命名空间。

包语句的语法格式为：

package pkg1[.pkg2[...]]

一般利用公司域名倒置作为包名，如www.baidu.com 开发的包名定义为com.baidu.www

为了能够使用某一个包的成员，需要在Java程序中明确导入该包，使用某个包成员时，不导入相关包会报错。

使用import语句可以完成此功能。

import package1[.package2[...]]

• 按住ctrl，再点击类名，可以查看源码
• import .*，通配符，表示导入某个包下的所有类。
• 阿里巴巴Java开发手册（规范化编程）

JavaDoc

JavaDoc命令使用来生成自己的API文档的。

参数信息：

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

jdk1.8帮助文档：

帮助文档地址：https://docs.oracle.com/javase/8/docs/api

生成JavaDoc文档的方法

• 通过cmd命令行。 在相关文档文件目录下打开cmd，快捷方法：在路径栏最前面加上cmd加空格（预科知识笔记有说），回车即可。命令：javadoc -encoding UTF-8 -charset UTF-8 文件名.java，加上UTF-8为了避免乱码。
• 通过IDEA。 在菜单栏找到Tools -> Generate JavaDoc，打开界面后根据情况勾选内容。

结果将会生成很多文件，其中index.html则是和Java API在线帮助文档一样的网页。可以看到，这就是公司自己开发发布API文档的原理啊（自己简单的理解）。