java包机制以及javadoc命令构造API文档

java包机制以及javadoc命令构造API文档

1.java的包机制

当你在一个文件夹下建立两个命名相同的文档时，会出现下面的情况：

图1

系统会自动提示你需要重新命名，但是，当你新建一个文件夹时并将其中一个文档放入里面，则两个文档命名就可以相同了，这就是为了避免在同一个包中出现命名相同导致后续的程序出现问题：
例如：

图2

所以，在java中，为了避免文件命名相同到导致出现问题的情况，Java中出现了包机制，一层包裹一层，这里注意：一般使用公司域名作为包名. 如百度的网址www.baidu.com,用作包名则需要倒置，创建时可以使用下面语句格式：
com.baidu.www
或者你在学习JavaSE时，可以创建下面的格式:
JavaSE.lu.base
则会生成下图文件:

图3

通过包机制管理java文件,解决同名文件冲突,其实包实际上也是一种访问控制机制,通过包来限制,或者说约束类之间的访问关系

2.import导入语句

在java中，若想调用出了java本身定义好的方法之外的其他文件类，需要用到导入语句，如图三，我在另一个包中想调用这个包中的Hello类，则需要在程序开头输入下面的导包语句

import JavaSE.lu.javase_base.Hello;

3.Java API 文档以及JavaDoc注释

java API帮助文档

可以百度搜索：jdk帮助文档–>可以查看API帮助文档，也可以下载

---

javadoc注释:javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档;一般用于标记文件创建时项目当时对应的版本,一般后面跟版本号,也可以跟是一个时间,表示文件当前创建的时间;

写一个doc类:

package JavaSE.lu.javase_base;
import java.lang.String;

/**
 * @author 86157卢
 * @version 1.8
 * @since 1.8
 */
public class doc{
    String name;

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

那如何将doc类中的文档注释构建在API文档中，便于查看呢。这里，需要用到javadoc命令

1. 首先，找到该doc类所在文件的地址，进入该文件路径下的命令行

2. 输入D:\java-code\src\JavaSE\lu\javase_base>javadoc -encoding UTF-8 -charset UTF-8 doc.java，其中encoding和charset参数是为了防止注释中出现中文而发生乱码.

3. 结果如下：
   
   4.打开doc类文件所在的文件夹，可以看到，生成了许多html文件.

打开index.html文件，可以进入创建的doc类API帮助文档，点进去可以即可查看doc类的所有注释.

…结束啦！咔.