包机制和javaDoc生成文档

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

包语句的语法格式为：

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

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

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

import package pkg1[.pkg2[.pkg3……]].(chassname|*);

相关实例如下：

当我们输入Date的时候，会自动调用java自建的Date包。

 当我们引用包的时候，避免所引用的类名与所定义的类名相同。

会出现如下错误：

当我们需要引用一个包的许多类的时候，我们无需一个一个的进行引用，里面有一个*，代表通配符，可以直接全部引用该包下面的所有类。导入这个包下所有的类。

包的作用体现如下：

1.当我们在桌面新建一个已经存在文本文档的时候，会提示要重命名文本文档

2.除了重新命名外，我们可以新建一个文件夹，将新建文本文档命名为和之前一样的名字，这个时候发现可以命名了。

 3.这时候我们在将这个文件夹拖到和它具有相同名字的文件夹里面，发现可以拖进去了。

 以上就体现出包的作用，包的本质就是文件夹

创建包的过程如下：

1.当我们新建一个包的时候，出现不分层级的现象的时候，我们点击设置，取消勾选Compact Middle Packages即可。

 2.我们通过对包的命名机制，将包命名如下：

 

3.创建完成后，即可出现如下的分级。

 

4.我们可以在百度下面继续创建新的包，比如baike、wenku，如下图所示：

5.创建成功的效果如下所示：

 

String详情界面：

1.我们按住ctrl,点击鼠标，进入String类的详情界面

2.进入之后，我们找到代码的最上端，发现它的包命名为lang包 

 

3.之后我们按住ctrl，鼠标左键进行点击，我们发现如下：

代码的编写规范具体可以参阅《阿里巴巴手册》进行学习https://www.doc88.com/p-31173366373572.html?r=1

java的文档注释（java特有）

格式：

/**
文档注释
 @author 指定java程序的作者
 @version 指定源文件的版本
 */

文档注释的使用：

/**
文档注释
 @author shkstart
 @version v1.0
这是我的第一个java程序，非常的开森！
 */

注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档。

我们来演示被javadoc所解析：

package com.ypl.exercise;

import java.util.Scanner;

public class A {
    /*
多行注释：
如下的main方法是程序的入口！
main的格式是固定的！
*/
    /**
     如下的方式是main(),作用：程序的入口。
     */

    public static void main(String[] args) {

        System.out.println("hello world!");
    }
}

我们将此文件利用cmd来进行编译：

 

javaDoc生成文档：

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

Java Platform SE 8,可以在这里面进行查找相关文档，进行学习。

一、CMD命令行生成javadoc文档

1.选中文件，点击Open in ,点击Explore即可

2.之后我们打开这样子的界面：

 3.之后我们利用cmd,即在导航栏前一列输入cmd.

 4.进入命令行后，我们使用javadoc进行命令的实行：为了避免报错，我们要采用可以识别中文的UTF-8这种编码方式进行编码

 5.我们在运行完毕后，打开刚刚的文件夹，发现多了好多文件夹，我们打开index.html即可。 

6.点进去的界面如下所示：

7.点击Doc，我们即可发现注释的相关内容： 

 二、IDEA生成javaDoc文档

1.首先新建一个文档用于存在生成的javaDoc文件

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

3.然后在弹出的界面中我们点击Output directory输入框后面的按钮，进行选择文件夹，如下图所示

4.选择我们刚刚创建的文件夹：

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

编码集为-encoding utf-8  -charset utf-8,可以识别中文，避免出错 

 6.然后点击ok以后我们就等待IDEA给我们生成JavaDoc文档即可，等到输出栏出现如下图所示的提示代表生成完毕7.

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

8.点击index.html，进入页面后点击Doc即可看到详细信息： 

在用cmd命令生成文档的时候，在输入命令的时候，需要把UTF-8字母进行大写。

 JavaDoc生成文档的具体代码如下：

package com.rgf.base;

/**
 @author rgf  作者
 @version 1.0  版本
 @since 1.8 自然号
 这是给类加注释，加在类上面就是类的注释
 */
public class Doc {
   String name;//属性

    /**
     *
     * @param name  参数
     * @return   返回值
     * 给方法加注释，自动生成的东西，加在方法上面就是方法的注释。
     */
    /**
     * @author rgf
     * @param name
     * @return
     * @throws Exception  抛出异常
     */
    public String test(String name) throws Exception{  //方法,抛出异常
        return name;
        /**
         * 参数信息
         * @author 作者名
         * @version 版本号
         * @since 指明需要最早使用的jdk版本
         * @param 参数名
         * @return 返回值情况
         * @throws 异常抛出情况
         */


    }
}