Java修炼之凡界篇 筑基期 第02卷 语法 第07话 包机制与JavaDoc生成文档

包机制与JavaDoc生成文档

包机制

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

• 包语法格式

  package pkg1[. pkg2[, pkg3...]]
      
  // 包可以理解为文件夹与子文件这样的关系
  
  // 例子：
  package com.soft.www.operator;
  
  // 类路径：
  com.soft.www.operator.Operator
  

• 企业中一般将公司域名倒置作为包名

• 为了能够使用某一包下的成员，我们需要在Java程序中明确导入该包

• 使用“import”语句可以完成该功能

  import com.soft.www.Variable;
  

JavaDoc生成文档

• JavaDoc命令是用来生成自己的API（帮助）文档

• 参数信息

  @author 作者名

  @version 版本号

  @since 指明需要最早使用的 jdk 版本

  @param 参数名

  @return 返回值

  @throws 异常抛出信息

• jdk自带命令 javadoc -encoding UTF-8 -charset UTF-8 生成Java帮助文档（也可以借助工具进行，例如IDEA生成）