Java包机制和JavaDoc文档生成方式

包机制

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

2. 包语法的语法格式为：

   package pkg1[. pkg2[. pkg3…]]

3. 一般利用公司域名倒置作为包名；(防止命名空间重复)

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

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

5. 示例

   package com.chen.operator;
   import com.chen.*;
   import com.chen.base.Demo01;
   
   public class Demo08 {
       public static void main(String[] args) {
           //x ? y:z
           //如果x==true，则结果为y，否则为z
   
           int score =50;
           String type = score<50?"不及格":"及格";
           System.out.println(type);
       }
   }
   

JavaDoc

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

2. 参数信息

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

3. 如何生成JavaDoc

   1. 利用command命令行生成

      首先找到要生成的Java文件的文件夹，利用在文件路径前加上cmd 从当前文件夹进入命令行，在命令行中输入javadoc -encoding UTF-8 -charset UTF-8 文档名.java回车，即可生成JavaDoc文档。

   2. 在IntelliJ IDEA中生成

      在Tools中找到Generate JavaDoc…在弹出的界面可以选择要生成的JavaDoc文档的范围、输出的目录（Output directory）、输出的语言格式（Locale）、编码集（-encoding UTF-8 -charset UTF-8）以及最大输出大小。最后点击OK可看到输出栏出现"javadoc" finished with exit code 1的字眼表示输出完成。

      

4. 如何查看生成的JavaDoc文档

   在生成的JavaDoc文件里找到index.html的文件，双击即可看到生成的JavaDoc文档。

​ 它把项目中所有的类，程序包都写到文档中了，非常的详细。

(img-xWzV3wmI-1612937340770)]

​ 它把项目中所有的类，程序包都写到文档中了，非常的详细。