java2：包机制和JavaDoc

Java包机制 和 JavaDoc

Java包

引入包idea设置

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

pack pkg1[.pkg2[.pkg3...]];

• 一般利用公司域名倒置作为包名（包的本质就是：文件夹—子文件夹）：

/*
比如我的域名为：www.joywon.com
则我的包名可以为：com.joywon.www
*/

注意：要通过com.joywon.www这种形式生成多层包，需要勾选Flatten Packages(展平包)，并取消Hide Empty Middle Packages

com为父文件夹，com.joywon为com的子文件夹，com.joywon.www为com.joywon的子文件夹

---

引入包

若包放在xxx目录下，则在包内开头需引入package xxx.xxx.xxx(路径)

package com.joywon.www;
//package com.joywon.www.*; 导入所有的包

public class Test {
    public static void main(String[] args) {
        int score1 = 100;
        int score2 = 50;
        String result1 = score1 < 60 ? "不及格" : "及格";
        String result2 = score2 < 60 ? "不及格" : "及格";
        System.out.println(result1);
        System.out.println(result2);
    }
}

---

JavaDoc

简介

• 简称：java帮助文档，通过/** content */包含
• 6种参数信息：

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

package com.joywon.www;
/**
 * @author Liu
 * @version 1.0
 * @since 1.1
 */
public class Test {
    String name;
	// 以下内容输入 /** 自动生成
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成javadoc文档

通过cmd手动生成

1. 打开文件位置

   

2. 调用cmd，并输入javadoc -encoding utf-8 -charset utf-8 Test.java

   需对文件和字符集进行编码，否则中文输出乱码；生成的index.html就是java自动生成的帮助文档首页

3. 若cmd运行出现错误，先检查环境变量中的classpath是否为绝对路径，相对路径则会生成失败

通过idea自动生成

• Tools ---- Generate JavaDoc ---- 选择需要输出的包地址 和 输出保存的文件夹