Step11 JavaDoc文档生成及包机制

包机制

• 包的本质就是文件夹

• 一般利用公司域名倒置作为包的名字：www.baidu.com=com.baidu.www

• 尽量别让导入的包名与当前文件重名

• 导入包代码格式：Import package.package.ClassName(注意必须在包机制的下面)

• 导入包的所有文件：import package.package.ClassName.(*即通配符,调用所有的类数据)

JavaDoc

• JavaDoc命令用于生成自己的API文档

• JDK帮助文档一般用1.8版本，网上有资源

• 参数信息

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

---

学会使用IDEA生成javaDoc命令且查看index首页*

• IDEA点击包"Show In Explorer"

• 本地找到文件，在路径前cmd执行命令

• Dos命令执行"javac -encoding UTF-8 -charset UTF-8"+(文件名).java

• 点击查看生成的本地文件"index.html"即可

package com.GodKuang.BasicPart;
/*
Javadoc生成api文档
 */
/**
 * @author 2opz
 * @version 1.0
 * @since 1.8
 *
 */

public class Doc {
String name;//属性
    /**
     * @author 2opz
     *
     * @param name
     * @return
     * @throws Exception
     */

public String test(String name) throws Exception {//定义的test方法
    return name;
    }
}