Java基础（包机制，JavaDoc生成文档）

包机制

---

包的本质就是文件夹

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

◆ 包语句的语法格式为：

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

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

package com.kuang.operator;


//导入这个包所有的类，    * 通配符
import com.kuang.base.*;

JavaDoc

---

◆Javadoc 命令是用来生成自己API文档的

◆ 参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

package com.kuang.base;

/**
 * @auther Kuangshen
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;

    /**
     * @auther Kuangshen
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception {
        return name;
    }

    //我是通过命令行   javadoc    参数   Java文件
    // -encoding UTF-8 -charset UTF-8   让index.html的中文显示的更正常

    /*作业：学会查找使用IDEA生产JavaDoc文档！     面向百度编程！
            点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。
            https://www.jianshu.com/p/bea85893fa89?utm_source=oschina-app
      */    

    //基础部分的一切知识，后面几乎每天都会用
}
	

命令行