JAVA学习——包机制+JAVADOC（基础篇）

包机制

为了更好的组织类，区别命名空间，类似文件夹，让项目看着更加整洁

一般用公司域名倒置作为包名

定义包

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

导入包

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

import com.moo.base.*;//将包里的全部class都导入

---

JavaDoc

官方jdk帮助文档在线网址

https://docs.oracle.com/javase/8/docs/api/

JavaDoc文档

javadoc命令用来生成自己的API文档,也是对类、或对包等进行一个注释

参数信息：(包括格式）
/**
*@author作者名

*@version版本号

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

*@param参数名

*@return返回值情况

*@throws异常抛出情况
*/

生产JavaDoc文档的方法

Doc命令行方法

javadoc -encoding UTF-8 -charset UTF-8 Demo1.java//中间是用来修改编码防止中文出现乱码

1. 找到想要生成文档的类的目录
2. 从路径出调用doc窗口（在路径前加cmd回车即可）
3. 输入命令
4. 运行成功后在类的目录下会生成很多新的东西
5. 打开其中的index.html(首页网址），可以看到和帮助手册差不多的界面，里边有我们自己注释的内容等。这就是javadoc命令与普通注释的区别
   
   

用IDEA方法

1. 在IDEA中打开tool中的一项
   
2. 在弹出的界面中修改红框框中的内容：zh_CN代表中文的意思，下边的同命令行一样是字符编码
   
3. 点击确认即可自动生成
4. 结果同上一个方法一样