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

2021-10-29 12:32:28 阅读：198 来源： 互联网

标签：4.6 Java name 之包 JavaDoc 文件夹文档 import lanseyutou

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文档

首先新建一个文件夹，用于存放要生成的javadoc文档
接下来点击IntelliJ IDEA顶部的Tools菜单，选择Generate JavaDoc 选项
然后在弹出的界面中我们点击Output directory输入框后面的按钮
在弹出的文件夹界面中选择刚才新建的文件夹
接下来在底部的Locale输入框配置语言和编码集，如下图所示，语言用zh_CN 代编中文
```
 -encoding utf-8 -charset utf-8
```
然后点击确认以后我们就可以等待Intellij IDEA 给我们生成的 JavaDoc文档即可
接下来我们打开JavaDoc文件夹，找到index.html文件,点击就能看到API文档。

标签：4.6,Java,name,之包,JavaDoc,文件夹,文档,import,lanseyutou
来源： https://www.cnblogs.com/lzk0628/p/15479865.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

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

1.包机制

2. JavaDoc