4.6.Java基础语法之包机制、JavaDoc

1.包机制

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

• 包----即文件夹

• 包语句的语法格式：

 package pkg1[.pkg2[.pkg3...]];
 ​
 package bilibli.lanseyutou.base;

• 一般利用公司域名倒置作为包名

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

 import pkg1[.pkg2[.pkg3...]];
 ​
 import bilibili.lanseyutou.base.Demo02;
 ​
 import bilibili.lanseyutou.base.*;//导入bilibili.lanseyutou.base包下所有的类

 

2. JavaDoc

• JavaDoc命令是用来生成自己API文档的

• JDK8帮助文档

• 参数信息：

  • @author 作者名

  • @version 版本号

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

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

 package bilibli.lanseyutou;
 ​
 /**
  * @author lanseyutou
  * @version 1.0
  * @since  1.8
  */
 ​
 ​
 public class Doc01 {
 ​
     String name;
 ​
     /**
      *
      * @param name
      * @throws Exception
      * @return
      */
 ​
     public String test(String name) throws Exception {
         return name;
 ​
     }
 }

然后打开该文件所在的文件夹，在路径前输入cmd打开windows powershell

输入javadoc -encoding UTF-8 -charset UTF-8 Doc01.java（javadoc 参数 文件名）

 

即可看到该文件夹下生成index.html文件，点开后即可看到类似于JDK帮助文档的页面

 

• 使用IDEA生成JavaDoc文档

1. 首先新建一个文件夹，用于存放要生成的javadoc文档

2. 接下来点击IntelliJ IDEA顶部的Tools菜单，选择Generate JavaDoc 选项

3. 然后在弹出的界面中我们点击Output directory输入框后面的按钮

4. 在弹出的文件夹界面中选择刚才新建的文件夹

5. 接下来在底部的Locale输入框配置语言和编码集，如下图所示，语言用zh_CN 代编中文

    -encoding utf-8 -charset utf-8

   

6. 然后点击确认以后我们就可以等待Intellij IDEA 给我们生成的 JavaDoc文档即可

7. 接下来我们打开JavaDoc文件夹，找到index.html文件,点击就能看到API文档。