Java基础(二)

包机制

在java中，包（package），相当于文件夹。包里通常存放的是类文件，因为我们在编写程序的时候，难免会有类名相同的情况。为了对类进行分类管理，java提出了包机制解决方案，在不同包中可以有相同的类名，调用的时候连同包名一起就行。

作用

• 避免多个类重名的情况，如果出现两个相同名字的类，可通过包将两者区分，从而避免冲突。
• 对类文件进行管理
• 给类文件提供了名称空间。
• 包的出现可以将java的类文件和源文件相分离。
• 在调用其他包中的类时，需要写类的全称，也就是连同包名一起书写。当类存在多层包中时，使用import导入后，使用其类时，就可以不加包名了。

规则

• 包必须写在程序的第一行，并且包名为全小写字母组成。因为要先有包，才知道class文件的存放地方。
• 类的全称：包名.类名。
• 编译定义了包的程序文件时，在编译时要指定包的存储目录。如：javac –d D:\CLASSPATH 类名.java

JavaDoc

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
	插入一个到另一个主题的链接
	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据	@serialData description
@serialField	说明一个 ObjectStreamField 组件	@serialField name type description
@since	说明从哪个版本起开始有了这个函数	@since release
@throws	和 @exception 标签一样.	The @throws tag has the same meaning as the @exception tag.
	显示常量的值，该常量必须是 static 属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本，一般用于类注释	@version info

实例：

package base;

/**
 * @author 无涯子
 * @since 1.8
 * @version 1.0
 */
public class Doc {
    private String name;

    /**
     *
     * @param name
     * @throws Exception
     */
    public void test(String name) throws Exception{
        System.out.println(name);
    }
}

打开命令行窗口并找到对应文件所在的目录，运行下面命令：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java // 设置编码字符集为utf-8，字符集也为utf-8

运行完成之后会生成如下文件：

然后点击index.html即可运行查看API文档