java 包机制 生成 java doc文档

包机制

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

为了能够使用某一个报的成员，我们需要在java程序中导入该包。使用“import”语句可完成此功能

一般利用公司域名倒置作为包名：com.kuangstudy.blog

import com.zhang.*;

*是通配符

Java Doc

官方doc文档介绍
Overview (Java Platform SE 8 ) (oracle.com)

用来生成自己的API文档

package com.zhang.base;
// 加在类上面 就是类注释
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8  指明最早使用的jdk版本
 * //@param    参数名
 */
public class Doc {
    String name; //类变量
    
    
// 加在 方法上面 就是方法注释 
    /**
     * @author kuangshen
     * @param name
     * @return
     * @throws Exception   异常抛出情况
     */
    public String test(String name) Exception {
        return name;
    }

}

生成 javadoc文档

package com.zhang.base;
// 加在类上面 就是类注释
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8  指明最早使用的jdk版本
 * //@param    参数名
 */
public class Doc {
    String name; //类变量


// 加在 方法上面 就是方法注释
    /**
     * @author kuangshen
     * @param name
     * @return
     */
    //@throws Exception   异常抛出情况
    public String test(String name)  {
        return name;
    }

}

在 程序存储的文件 我的电脑-文件 上 导航栏-最前部 加上 CMD 回车键 进入 命令

输入 以下 javadoc -encoding UTF-8 -charset UTF-8 Doc.java

回到 程序所在 位置 会生成很多 文件 选中下图所算 文件 即可 查看 doc文档

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jQnTGWit-1641095809947)(C:\Users\PC\AppData\Roaming\Typora\typora-user-images\image-20220102115229057.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ybdqketL-1641095809948)(C:\Users\PC\AppData\Roaming\Typora\typora-user-images\image-20220102115423049.png)]