包机制和JavaDoc文件

包机制

1. 包的本质就是文件夹的作用
2. 一般利用公司域名倒置作为包名，例如百度：com.baidu.www
3. 在代码中按住Alt+回车会自动生成报错信息和相关改正
4. 代码中，包必须是在首行，package…
5. 引入包import语句放在package语句下面
6. 包语句语法格式： package pkg1[.pkg2[.pkg3…]];
7. 引入包语句语法格式： import pkg1[.pkg2…] (classname|*);
8. import.pkg.*; 含义：导入包里面的所有类
9. 阿里巴巴开发手册，你值得看一遍

JavaDoc生成文档

1. 搜索JDK帮助文档，保存好网址

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

3. 相关参数：

   ​ @author 作者名

   ​ @version 版本号

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

   ​ @param 参数名

   ​ @return 返回值情况

   ​ @throws 异常抛出情况

4. /** （回车）… */ ：放在类的上面就是类的注释，放在方法的上面就是方法的注释

5. 生成API文档步骤：javadoc 参数 java文件

   1. 找到类所在位置，从地址栏进入cmd
   2. 在位置后面输入：java.doc -encoding UTF-8 -charset UTF-8 Doc.java;
   3. -encoding UTF-8:为了让编码好看； -charset UTF-8：为了让字符好看。
   4. 生成后打开index.html(首页的意思)

6. 方法5是使用命令行生成的JavaDoc文档，接下来学会使用IDEA生成JavaDoc文档

7. 1、打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。

   2、进行配置：

   

   标注的是重要的部分，从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。

   这里的命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

   -encoding utf-8 -charset utf-8
   

   还可以配置那些注解需要生成，哪些权限类（private、package、protected、public）需要生成等等精细的控制。

   还有一点需要注意，即不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误。

   3、配置好后，点击生成按钮，生成好后就会自动在浏览器打开进行查看咯，是不是很棒O(∩_∩)O~

   作者：deniro
   链接：https://www.jianshu.com/p/bea85893fa89
   来源：简书

   2021.02.24