六、包机制与JavaDoc

灰太狼 2022-10-13 15:57 176阅读 0赞

# 一、包机制 #

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。  
包语句的语句格式为：

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

**一般使用公司域名倒置作为包名：例如（com.baidu.www）**

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

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

# 二、JavaDoc #

## 2.1、基本概念 ##

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

参数信息

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

## 2.2、实现 ##

### 2.2.1、先写好代码 ###

package JavaDoc;
    
    /**
     * @author xiaobai
     * @version 1.0
     * @since 1.8
     */
    
    public class Doc {
    
        String name;
    
        /**
         *
         * @param name
         * @return
         * @throws Exception
         */
    
        public String test(String name) throws Exception{
            return name;
        }
    
    }

### 2.2.2、打开文件夹并打开命令行 ###

1.打开所写代码的文件夹  
2.在路径前面输入cmd并回车  
![在这里插入图片描述][20210707203907458.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70]

### 2.2.3、输入命令 ###

输入**javadoc -encoding UTF-8 -charset UTF-8 +（你的class的名称）Doc.java**

这里我的名称是Doc.java。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 1]  
**出现上述情况即为正常**

### 2.2.4、打开index.html ###

**先打开class所在文件夹**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 2]  
**打开index.html**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 3]  
**出现上述情况就完成了**

[20210707203907458.png]: /images/20221005/b9b08f0aaabd457ca10c470670f83c4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70]: /images/20221005/1f6929370e48454db4f9302fb7efe64b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 1]: /images/20221005/7b8c7a166bee4e749d32ce8ee0590eec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 2]: /images/20221005/9174be685cbf43879c8104c281081c65.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzUyOTE2NDA4_size_16_color_FFFFFF_t_70 3]: /images/20221005/759f526269dd4098b12c12208b688419.png