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

合集 - Java(30)

1.Java入门——介绍及安装2022-03-052.Java基础01：注释、标识符、数据类型2022-03-053.Java基础02：类型转换、变量、常量2022-03-064.Java基础03：基本运算符2022-03-07

5.Java基础04：包机制、JavaDoc生成文档2022-03-08

6.Java流程控制01：Scanner对象2022-03-087.Java流程控制02：顺序结构和选择结构2022-03-098.Java流程控制03：循环结构2022-03-109.Java方法2022-03-1110.Java数组01：数组的定义、声明、创建、初始化和内存分析2022-03-1211.Java数组02：数组使用、多维数组、冒泡排序和稀疏数组2022-03-1312.Java面向对象01：类与对象的关系、创建和初始化对象2022-03-1413.Java面向对象02：封装和继承2022-03-1514.Java面向对象03：抽象类、接口和内部类2022-03-1715.Java异常2022-03-1716.SpringBoot和微服务架构2022-03-1717.SpringBoot基础01：创建项目和编写HTTP接口2022-03-1918.SpringBoot基础02：自动装配原理、yaml语法和JSR-303数据校验2022-03-2019.SpringBoot基础03：静态资源和首页定制2022-03-2420.Java多线程01：什么是线程和线程的创建2022-03-2521.Java多线程02：静态代理模式和Lambda表达式2022-03-2722.Java多线程03：线程的五大状态2022-03-2823.Java多线程04：线程优先级、守护线程和线程同步2022-03-2924.Java多线程05：死锁、LOCK和线程协作2022-03-3025.网络编程基础01：网络编程概述、IP和端口2022-04-0226.网络编程基础02：TCP实现聊天和文件上传2022-04-0627.Java注解和反射01：注解2022-04-0628.Java注解和反射02：反射基本概述和获得Class类的几种方式2022-05-1729.Java注解和反射03：类加载2022-05-1830.Java注解和反射04：Class对象的使用2022-05-19

收起

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;
    }
}