包机制、javadoc生成文档

包机制

• 为了更好地组织类，Java提供了包机制，由于区分类名的命名空间
• 包的语法格式：

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

• 一般利用公司域名倒置作为包名；com.kuangstudy.www
• 为了能够使用一个包的成员，需要在Java程序中导入该包

import package1[.package2...].(className|*); //通配符* 导入包下所有的类

• 参考：阿里巴巴Java开发手册

JavaDoc生成文档

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

参数信息

• @author 作者名
• @version 版本号
• @since 指明最早用的jdk版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

API文档：https://docs.oracle.com/javase/8/docs/api/

/**
*@auther kuangshen
*@version 1.0
*@since 1.8
*/
public class Demo05{
    String name;
    
    /**
    *@auther kuangshen
    *@param name
    *@return
    *@throws Exception
    */
    public String test(String name) throws Exception{
        return name;
    }
}

1. 打开某个类所在文件夹下的cmd命令行
2. 输入：javadoc -encoding UTF-8 -charset UTF-8 Doc(类名).java
3. 会自动生成该类有关的API文档，查看文件夹发现多了一些文件
4. 打开 index.html（首页）查看文档注释