学习日记（包机制和 JavaDoc 生成文档（命令行和 IDEA））

学习日记

包机制和 JavaDoc 生成文档（命令行和 IDEA）

1. 包的本质就是文件夹。规范：一般利用公司域名倒置作为包名，如 com.Sun3285.www。
   

2. 包语句为 package ，导入包用 import ，且 import 必须在 package 的下面。

package com.Sun3285.operation;

import com.Sun3285.base.practice_one;   //导入包
import com.Sun3285.base.*;          //导入这个包下所有的类

public class PracticeSeven {
    public static void main(String[] args) {
        
    }
}

3. 在线 API 帮助文档：版本8链接。
   

4. 给类和方法加文档注释如下。

package com.Sun3285.base;

/**
 * 给类加文档注释
 * @author Sun3285
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;     //属性

    /**
     * 给方法加文档注释
     * @author Sun3285
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{   //方法
        return name;

    }
}

参数信息有：

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

5. 用命令行生成 JavaDoc 文档方法

• 用 cmd 命令打开 Java 文件所在目录。
  
  

• 输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java，表示“用 UTF-8 方式编码，不出现乱码”，其中Doc.java为要生成文档的 java 文件，回车。
  
  

• 打开 index.html 可以看到文档的具体信息。
  

6. 用 IDEA 生成 JavaDoc 文档方法

• 打开“工具”，选择“生成 JavaDoc”。
  

• 选择生成 JavaDoc 的范围（整个项目 or 指定项目），自定义输出目录（便于管理放在单个文件夹），区域设置（中文为 zh_CN，英文为 en-ww），其他命令行参数，一般为-encoding UTF-8 -charset UTF-8（为了显示中文不出现乱码）。
  

• 查看
  
  

---

注意：

• 建包时若不能出现分级，取消该选项。
  

• Ctrl + 鼠标，可以点击查看类的一些东西。

• 尽量不要让包的名字重复。

• 好用的截图工具Snipaste：下载链接，提取码：bpv4。