包机制、JavaDoc

包机制、JavaDoc

---

包语句的语法格式为：

package pkg1[.pag2[.pag3...]];

• 一般利用公司域名倒置作为包名； 例如：com.sam.xxx.www

若想导入一个包下所有类，则在最后加* com.sam.xxx.*

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

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

JavaDoc

---

javdoc命令是用来生成自己API文档的操作

参数信息

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

可以由以下两种方式生成Doc文档：

第一种：

1. 在IDEA中找到需要生成的文件，右键单击explorer打开电脑中对应文件夹

2. 对打开文件的地址栏前加cmd，进入命令行界面

3. 在命令行中输入下列代码javadoc -encoding UTF-8 -charset UTF-8 Doc.java

4. 打开相应文件夹，找到index.html，打开

6. 完成，小功告成！

---

第二种：（推荐）通过IDEA直接生成javaDoc文档

1. 找到需要生成的文件，如图示找到Tools——Generate JavaDoc打开

2. 如下图，根据情况修改红色区域

3.生成文档后步骤同上，小功告成！