07包机制 javadoc

Java基础04

包机制

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

• 包语句的语法格式为：

  package pkg[.pkg2[.pkg3…]];//
  package com.studyhao1999.operator;//只能放在最上面
  

• 一般公司域名倒置作为包名；

  • 例如：www.studyhao1999.com,可以使用com.studyhao1999

    

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

  import package1[.package2…].(calssname|*)//*是通配符，可以使用旗下所有的类
  

JavaDoc

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

package com.studyhao1999.base;
//加在类上面就是类的注释，加在方法上面就是方法的注释
/**
 * @author studyhao1999
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;//属性

    /**
     *
     * @param name
     * @return
     */
    //自动生成！！

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

• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
• 加在类上面就是类的注释，加在方法上面就是方法的注释

使用 cmd 生成 javadoc 文档

1. 在idea中右键需要生成的javadoc的文件，并选择open in-->Explorer,打开文件所在文件夹

2. 在地址栏前输入cmd 空格并 回车打开cmd

3. 在输入界面输入

javadoc UTF-8 -charest UTF-8 文件名.java

使用 idea 生成 javadoc 文档

1. 打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面
2. 进行配置

• 从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。
• 命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

-encoding utf-8 -charset utf-8

• 不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误

3. 配置好后，点击生成按钮，生成好后就会自动在浏览器打开进行查看