java包与Doc文档

包机制

包就是一个文件夹，包的格式就是文件夹的格式，用于存储不同的文件

在java文件中，创建文件时就会自动导入package，这个必须有，必须放在最上面，没有就会报错，这个是用来声明你的java文件在哪的

格式为

• package pkg1[.pkg2[.pkg3]]

命名习惯

• 一般用公司域名的倒置进行命名 www.baidu.com — com.baidu.www
• 当然也可以使用自己的域名进行命名
• 另外，这些都只是习惯上这么弄，你自命名自己能看懂就行，只是为了方便以后管理

导入包

• 使用import关键字，import pkg1[.pkg2[.pkg3]]
• 不能在package上面导入
• 导入之后就能使用该包里的内容
• 要是要使用的东西很多，可以使用 *号 import pkg1* pkg1下的所有东西都可以进行使用，* 为通配符

javaDoc

Java支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc生成 API 帮助文档

文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释

Javadoc标签

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字

若是想查看更多的javadoc相关知识，自行上网搜索吧，作为一个了解即可

Javadoc 常用的标签 可能平时在文档注释时只会用到param throws return，因为这些一般都是自动生成的

标签	描述
@author	标识一个类的作者，一般用于类注释
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用
@exception	可能抛出异常的说明，一般用于方法注释
@param	说明一个方法的参数，一般用于方法注释
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中
@throws	和 @exception 标签一样.
@version	指定类的版本，一般用于类注释

Javadoc命令

Javadoc 用法格式如下

javadoc [options] [packagenames] [sourcefiles]

• javadoc -encoding UTF-8 -charset UTF-8 file
• file 就是文件名，中间的就是一些参数用于增强可读性的

输入javadoc -help就可以看到 Javadoc 的用法和选项

下面是整理的一些常用参数

名称	说明
-public	仅显示 public 类和成员
-protected	显示 protected/public 类和成员（默认值）
-package	显示 package/protected/public 类和成员
-private	显示所有类和成员
-d	输出文件的目标目录
-version	包含 @version 段
-author	包含 @author 段

基础的基础已经结束了

记住一句话

• 遇到不会就谷歌或者百度，网上的资源很多很多