Day07 包机制与JavaDoc

2022-09-14 21:48:11

包机制

包的本质是文件夹，用于分类应用；packet定义包
规范：一般利用公司域名倒置作为包名
为了能够使用某一个包的成员，我们需要在java程序中明确导入该包，使用“import”语句完成此功能

=其他语言的引入库
防止命名空间重复

JavaDoc

文档注释

JavaDoc命令是用来生成自己API文档
参数信息：@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

package Operator;

/**
 * @author hanker
 * @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;
    }


}

命令行生成javadoc

javadoc -encording UTF-8 -charset UTF-8 Doc.java

使用IDEA生成javadoc

1.打开idea，点击Tools->Generate JavaDoc ,打开生成javadoc文档配置页面

2.进行配置

务必输入 encoding utf-8 -charset utf-8

3.生成