（java）包机制和JavaDoc

包机制

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

• 包语句的语法格式为：

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

• 一般利用公司域名倒置作为包名

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

  • import Java.util; : 使用直接导入所有类

package com.xd.base;
import java.util.Date;
public class Demo02{
    public static void main(String[] args) {
        int score = 80;
        String type = score < 60 ? "不及格" : "及格";    //必须掌握
        System.out.println(type);
    }
}

• 《阿里巴巴Java手册》

JavaDoc

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

• 参数信息

  1. @author 作者名

  2. @version 版本号

  3. @since 指明需要最早使用的jdk版本

  4. @param 参数名

  5. @return 返回值情况

  6. @throw 异常抛出情况

加在类上面就是类注释

加在方法上面是方法注释

package com.xd.base;
//类注释
/**
 * @author xd
 * @version 1.0
 * @since 1.8
 */
public class Doc {
​
    //方法
    String name;
    
    //方法注释
    /**
     * @author xd
     * @param name
     * @return
     * @throws Exception
     */
    //属性
    public String test(String name) throws Exception{
        return name;
    }
}

使用命令行生成文档

1. 找到路径

2. 路径前加 cmd

3. 输入：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

4. 找到路径，点击index.html