当前位置 博文首页 > AiY..的博客：Java包机制及JavaDoc
Java包机制：
目的：为了更好地组织类，Java提供包机制，用于区别类名的命名空间。
包机制的语法格式：
package pkg1[.pkg2[.pkg3...]];
为了能够使用某一个包，在写Java程序的时候就需要明确导入该包，使用“import"实现
导入包的语法格式：
import package1[.package2...].(classname|*);//*表示该包的所有类
注意：导入包一定要在包机制下面。
JavaDoc:
目的：javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
1、常用标记：
代码实现：
package Test;
/**
* @author wei
* @version 1.0
*/
//Javadoc命令是用来生成自己的API文档
public class Doc {
String name;
/**
* @author wei 作者名
* @version 1.0 版本号
* @since 1.8 指明需要的最早使用的jdk版本
* @param 参数名
* @param name
* @return
* @throws Exception 抛出异常
*/
public String test(String name) throws Exception{
return name;
}
}
2、命令格式：
Javadoc命令格式如下：
javadoc [选项] [软件包名称] [源文件]
*****执行的命令*****
-overview <文件> 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员（默认）
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息
