包机制+javadoc生成文档

包机制：

包名：公司域名倒置

为了能使用某个包的成员，我们需要在java程序中明确导入该包，使用import语句即可。

import com.Cai.*;//这样的话就是导入这个包里的所有类

Javadoc帮助文档：

jdk帮助文档网址

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

参数信息：

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

package big;
import com.Cai.*;
/*
* @author cai
* version 1.0
* since 1.8
* */
public class Annotation {
   String name;
    /**斜杠两个星号回车才会自动帮你生成文档注释
     *
     * @param name
     * @return
     * @throws Exception
     * 加在类上面就是类的注释
     * 加在方法上面就是方法的注释
     */
    public String test(String name)throws Exception{
        return name;
    }
}

从文件夹中打开这段代码：

进入该文件的cmd模式，并输入对应的命令：

然后回到文件夹，打开生成的index.html文件

如下：

idea生成api文档链接
idea直接生成javadoc文档效果如下：