JAVA基础：包机制、JavaDoc

包机制

1. 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。包的本质就是一个文件夹。

2. 包含的语法格式为

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

3. **一般利用公司域名倒置作为包名；**com.xxx.www
   
   

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

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

• 输入Date时，IDEA（2020.3.3 x64）自动导入import javax.xml.crypto.Data;

• 当需要导入一个包的时候输入import com.qiaomai.www.operator.Demo01;但是导入的包不能与被导入的包重名。

• 如果需要导入这个包下的所有的类，则输入import com.qiaomai.www.operator.*;

tips：推荐阅读阿里巴巴开发手册

Java Doc

1. javadoc命令是用来生成自己的API文档。JDK8帮助文档就属于官方的API文档。

   可以在“类“前面使用" /** "来编写javadoc。

可以在“方法“前面使用" /** "+回车 来编写javadoc，参数可以自动生成。

1. 参数信息

   @autuor 作者名

   @versio 版本号

   @since 指明需要最早使用的jdk版本

   @param 参数名

   @return 返回值情况

   @throws 异常抛出情况

如何生成JavaDoc

1. 在命令行中实现。

在命令行中输入命令javadoc -encoding UTF-8 -charset UTF-8 Doc.java，然后生成JavaDoc文件。

2. 在IDEA中实现。

   第一步：在工具栏中找到 Tool，然后找到 Generate JavaDoc。
   

   第二步：对其进行配置，我的配置如下。

   1. 生成的部分时整个项目还是部分项目
   2. 生成文件存放的位置
   3. 选择需要生成的参数信息
   4. 输入-encoding UTF-8 -charset UTF-8，避免出现乱码

第三步：JavaDoc生成完成