包机制
为了更好地组织类,Java提供了包机制,用于区别别类名的命名空间。
包的本质就是文件夹
-
包语句的语法格式为:
package pkg1[.pkg2[.pkg3...]];
-
一般利用公司域名倒置作为包名
www.baidu.com -->com.baidu.www
-
为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用“import”语句可完成此功能
import package1[.package2...].(classname|*);
JavaDoc
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
/**
* @author 13754
* @version 1.0
* @since 1.8
*/
public class Demo05 {
String name;
/**
* @author 13754
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
//命令行:javadoc 参数 java文件
}
Javadoc命令格式如下:
javadoc [选项] [软件包名称] [源文件]
执行的命令
-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 不显示状态消息
生成Doc文档方法:
打开方式一:
在文件所在位置打开命令栏(cmd)
输入:javadoc -encoding UTF-8 -charset UTF-8 加上XX.java
打开方式二:
IDEA内打开—>tool—>Generate JavaDoc如图:
在Other command line argumens那一栏写:
-encoding UTF-8 -charset UTF-8 -windowtitle “Doc” -link http://docs.Oracle.com/javase/8/docs/api
打开Doc文档所在文件夹,找到以java文件命名的html文档,打开就是了。
-encoding UTF-8 -charset UTF-8这个防止乱码