Day09-Java的包机制以及JavaDoc的两种生成方法

Java的包机制

定义一个包

注意：一般利用公司域名的倒置作为包名且包名小写

例如：com.baidu.www

若新建包没有分层，可在右上角小齿轮处去掉Flatten Packages和Hide Empty Middle Packages的勾即可

导入一个包

注意：导入一个包使用“import”语句

例如：想在包中使用Date功能

package com.ezra.base;

//*（通配符）导入这个包里所有的类
import com.ezra.base.*;
//导入Date功能
import java.util.Date;
public class Demo13 {
    public static void main(String[] args) {

    }
}

包名必须在最上面，接下来才是导入的包

JavaDoc

参数信息

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

package com.ezra.base;

/**
 * @author Ezra Xu 作者
 * @version 1.0    版本
 * @since 1.8      jdk版本
 */
public class Demo14 {
    String name;

    /**
     *
     * @param name   参数名
     * @return       返回值
     * @throws Exception   异常抛出情况
     */
    public String test(String name)throws Exception{
        return name;
    }
}

生成JavaDoc文档

1. 通过cmd生成JavaDoc文档
   • 在命令行中找到Java文件
   • 使用代码：javadoc -encoding UTF-8 -charset UTF-8 Demo07.java
   • 在生成的index.html文件中查看详情
2. 使用IDEA生成JavaDoc文档
   • 在IDEA的导航栏找到Tools
   • 在Tools下找到Generate Java
   • Output directory选择JavaDoc文档的输出位置
   • 在Other command line arguments中输入”-encoding UTF-8 -charset UTF-8“保证中文的兼容性
   • 点击OK输出，在生成的index.html文件中查看详情