【学习日记（包机制、JavaDoc）】Day.10

包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。(包的本质就是文件夹)

• 包语句的语法格式为：

  package pkg1[.pkg2[.pkg3...]];

• 一般利用公司域名倒置作为包名；www.baidu.com com.baidu.www baike

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

  import package1[.package2...].(classname*);

  尽量不要让类名重复，同一个包下类名重复会报错

导入包下所有的类用“*”

import com.luobo.base.*;

推荐：阿里巴巴Java开发手册

JavaDoc

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

• 参数信息

  • @author 作者名

  • @version 版本号

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

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

package com.luobo.base;
​
/**
 * @author luobo
 * @version 1.0
 * @since 1.8
 */
public class Doc {
​
    String name;
​
    /**
     * @author luobo
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
    //我是通过命令行生成的  javadoc  参数 Java 文件
}

1. 打开doc所在文件夹

2. 进入cmd界面

3. 使用代码 “javadoc -encoding UTF-8 -charset UTF-8 Doc.java”生成html文件

注：其中“-encoding UTF-8 -charset UTF-8”是用于让中文显示的更好

4. 文件“index-all.html”可双击打开查看

作业：学会查找使用IDEA生成JavaDoc文档！ 面向百度编程！