04Java基础语法之包机制

包机制

• 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。

• 包语句的语法格式为：

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

• 一般会使用公司域名倒置作为包名；
  
  例如，www.baidu.com网站，设置成包名的话就变成了，com.baidu.www
  
  

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

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

  注意: 1. 导入的包位置，不能在程序的包的位置上面。
  
  2. 导入的包名不能和程序的包名相同。

JavaDoc

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

格式如下：

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

使用命令操作的话，需要在命令行窗口输入：
``` java
javadoc -encoding UTF-8 -charset UTF-8 XXX.java

执行完毕后，会在XXX.java文件的同级目录下，生成好多html文件，找到index.html文件打开就能看到。

IDEA生成JavaDoc文件

1. 首先，打开设置->编辑器->常规->外观，找到渲染文档注释，将其勾选后点击确定。
2. 在声明前输入/**,在按回车，会自动完成文档注释。
3. 在要声明的方法名上，按alt+enter,在列表中选择Add Javadoc。
4. 在编辑器中查看Javadocs，按ctrl+Q，快速查看文档。