Java基础11：包机制、JavaDoc生成文档

包机制

• 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间
• 一般利用公司域名倒置作为包名

package com.panpan.operator;

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

import com.panpan.base.Demo;//导入com.panpan.base下的Demo类
import com.panpan.base.*;//导入com.panpan.base下的所有类

• 通常是类的第一句非注释语句
• 同一个包里不能有同名的类

Java Doc

• javadoc命令是用来生成自己API文档的
• 参数信息

1. @author 作者名
2. @version 版本号
3. @since 指明需要最早使用的jdk版本
4. @param 参数名
5. @return 返回值情况
6. @throws 异常抛出情况

package com.panpan.base;

/**
 * @author Asher 
 * @version 1.0
 * @since 12.0
 */
public class Demo05 {
    String name;

    /**(可自动生成)
     * @author Asher
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
    
}

如何生成Demo05的API

1. 打开类所在文件夹
   
2. 在文件夹下打开运行窗口 cmd 地址
3. 输入javadoc 参数 Java文件
   
4. 生成一系列文件
5. 双击下图中的文件，即生成的API
   
   效果图
   
   

拓展：百度寻找其他方法生成JavaDoc文件

方法二
方法二