今天总结一下java的包机制及javaDoc.
我主要还是要强调java语言书写的规范

一、java中的包机制

  • 为了更好地组织类,Java提供了包机制,用于区别类名的命名空间。
  • 包语句的语法格式为:
	package pkg1[.pkg2[.pkg3...]];

  • 一般利用公司域名倒置作为包名;
  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用’"import"语句可完成此功能

二、JavaDoc生成文档

1.认识javaDoc

之前我介绍过java中注释怎么书写,那么注释里面会书写很多我们代码的相关信息。那如果我们不想看代码只想看注释怎么办呢?javaDoc的作用就体现出来了。
javaDoc的主要作用就是生成我们自己的API文档

这就是java8的API文档:

2.javadoc 标签

 @author	    标识一个类的作者
 @deprecated    指名一个过期的类或成员
 @version 	  指定类的版本
 @param 	    说明一个方法的参数
 @return 	   说明返回值类型
 @exception     标志一个类抛出的异常

  1. 通过idea生成自己的API文档
  2. 选择Tools --> Generate JavaDoc 就会出现以下界面
  3. 在你选择输出javaDoc的文件夹下下方会出现很多文件,其中有个index.html文件就是生出的API文档打开页面

总结

今天写的有些人认为不是什么重要的东西,但是我认为这些是很重要java规范,是一种良好的写代码的习惯。希望自己的代码能够被别人赞美。。。。。。
加油!

Q.E.D.