java.学习笔记day06（包机制，javaDoc生成文档）

包机制

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

2. 包语句的语法格式为:

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

3. 一般利用公司域名倒置作为包名;

   比如：公司域名 www.baidu.com

   包名：com.baidu.www

4. （导包）为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用"import”语句可完成此功能并且必须在package下面

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

定义包和导入包

（导入包必须在定义包下面，就是import在package下面）

        //定义包，是该类的父包（假如该类pkgtwo下面的类，则是如上定义）
        package com.langtu.pkgtwo;
        //导入langtu包下所有的类
        package com.langtu.pkgone.*;
        //导入langtu包下的one类
        import com.langtu..pkgone.one;

javaDoc生成文档

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

与文档注释一起使用。

参数信息

1. @author 作者名

2. @version 版本号

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

4. @param 参数名

5. @return 返回值情况

6. @throws 异常抛出情况

例如

package com.kuang.base;
/**
 * @author Kaungshen
 * @version 1.e
 * @since 1.8
 */
public class Doc {
    
string name;
    
 /**
* @author Kaungshen
* @param name
* @return
* @throwsException
*/
    public String test(string name)throws Exception{
return name;
    }
}

代码生成文档

1.命令行生成

代码：javadoc -encoding UTF-8 -charset UTF-8 java文件名称

-encoding UTF-8 编码格式设置为UTF-8

-charset UTF-8 字符集格式设置为UTF-8

例如打开Doc.java文档步骤：

1. 打开要生成文档的java文件位置

2. 在文件导航栏前面加cmd+空格打开控制台

3. 在控制台中输入代码：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

4. 打开index.html文档

5. 点开Doc即可