Day 11-- Java基础05 -- 包机制&JavaDoc

包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间（本质就是个文件夹）

• 包语句的语法格式为：

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

• 一般利用公司域名倒置作为包名，包名要倒着写com.xxxx..xxx（在idea中建包时如果想直接以.进行不同层级的包分类，点击项目结构右上角的设置按钮，取消勾选Compact Middle Packages）

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

  import package1[.package2...].(classname|*);
  //import要放在package名之后 .*为通配符，会导入这个包下所有的类
  

JavaDoc

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

参数信息

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

可以生成类的doc注释也可以生成方法的，注释的参数会有所不同

两种生成javaDoc的方式

1. 命令行生成javaDoc方法：javac [-编码类型] java文件名

   exp: javadoc -encoding UTF-8 -charset UTF-8 Doc.java

2. 通过idea生成javaDoc方法：

   1）Tools–>Generate JavaDoc
   2）填入必要配置,点击OK

   注意：javadoc命令运行时，默认用了gbk，需要我们在

   ＂Tools->Gerenate JavaDoc”面版的Other command line arguments 栏里输入：-encoding utf-8 -charset utf-8
   否则报错： 编码gbk的不可映射字符