包机制和javadoc

包机制

一般用公司域名倒置作为包名：

eg com.baidu.www

可以在src里自己鼠标右键建立包，包内可以存放代码，

包的路径必须在最上面，

eg:package com.kuang; （自动生成）

引入其他包的代码：

使用import即可完成

import com.kuang.haha; (haha是代码文件的名字)

import com.kuang.* (*代表了kuang内的所有类全部导入)

同名引入会出错，不允许（引入的代码名在该包内已经出现）

---

java doc

注释的一种，文档注释

参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @ throws 异常抛出情况

加在类上面就是类的注释。加在方法上面就是方法的注释。

public class Hello{
    string name;
    /**
    @author:haa
    @since:1.8
    */
    //(在方法上，所以就是方法的注释)
    public string test(string name)
    {

    }
}
​

生成API文件

1、dos命令执行生成

通过dos命令窗口，直接将文件通过

javadoc 参数 文件名 （ 回车执行）

参数例如：-encoding UTF-8 -charset UTF-8

参数作用：让生成中的文件包含中文而不乱码

执行就可以生成文件了。

其中生成的index.html文件可以查看详细的信息

2、idea生成

一、在工具栏中找到 tool >> Generate JAVADoc

二、 自定义选择

1. Whole project ： 整个项目都生成

2. Uncommitted files ： 没有提交的文件

3. Custom scope： 自定义范围 ：project files 项目文件，project production files 项目产品文件，project test files 项目的测试文件， 未知范围，class hierarchy 类层

4. include test source： 包含测试目录

5. include JDK and library sources in -sourcepath：包含jdk和其他的第三方jar

6. link to JDK documentation (user-link option) ： 链接到JDK api

7. Output directy： 生成的文档存放的位置

8. private、package、protected、public ：生成文档的级别（类和方法）

9. 右边的Generate…是选择生成的文档包含的内容,依次对应顺序：层级树 导航 索引 单独的字母索引

10. 再右边是生成的文档包含的内容信息,依次对应顺序：使用 作者 版本 废弃 废弃名单

11. Locale 语言类型,zh-CN 中文

12. Other command line arguments: 其他参数

13. Maximum heep size (Mb)： 最大堆栈

注：本文设置 -encoding UTF-8 -charset UTF-8 -windowtitle “test” 设置了编码字符集都是utf-8，并设备文档标签标题

点击ok 。