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

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

包机制

包的本质就是文件夹。

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

• 包语句的语法格式为：package pkg1[. pkg2[. pkg3...]];

  package com.lurenj.operator;//必须写在首行
  public class Demo01 {
      public static void main(String[] args) {
        ......
      }
  }
  

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

  以域名：www.lurenj.com为例创建包名：
  

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

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

  package com.lurenj.operator;//必须写在首行
  //package com.lurenj.*; 导入lurenj包下所有的类
  import java.util.Date;
  public class Demo01 {
      public static void main(String[] args) {
        Date;//Date java内置类
      }
  }
  

  代码规范可参考阿里巴巴Java开发者手册：

  阿里巴巴开发者手册
  提取码：6666

JavaDoc

Java SE在线帮助文档JDK8

JavaDoc命令生成自己的API文档：javadoc -encoding UTF-8 -charset UTF-8 Doc.java 把执行的java文件变成一份文档，会生成html/css/js等一系列文件，类似Java SE在线帮助文档的页面。

参数信息

• @author 作者姓名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param 参数名
• @return 返回值情况
• @throw 异常抛出情况

package com.lurenj.base;

/**
 * @author lurenj
 * @version 1.0
 * @since 1.8
 */
//Doc加在类上面就是类的注释
public class Doc {
    String name;

    /**
     * @author lurenj
     * @param name
     * @return
     * @throws Exception
     */
    //加在方法上面就是方法的注释
    public String test(String name) throws Exception{
        return name;
    }
}