Java基础语法(三)
包机制
- 为了更好地组织类,Java提供了包机制,用于区别类名的命名空间。
- 包语句的语法格式为:
package pkg1[.pkg2[.pkg3...]];
package com.tyro1;
- 一般利用公司域名倒置作为包名,如com.baidu.www;
- 为了能够使用某一包的成员,我们需要在Java程序中明确导入该包。使用“import”语句可完成此功能。
import package1[.package2...].(classname|*);
import com.tyro.Demo1;
import com.tyro.*; //*(通配符),表示导入包内所有成员
JavaDoc
- javadoc命令是用来生成自己API文档的
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
package com.tyro1;
/**
* @author tyro
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
//会自动根据程序中的方法生成文档注释;
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{ //throws Exception表示抛出异常
return name;
}
}
//找到要编译的类所在的文件夹目录,使用目录方式打开cmd控制台;(右键类,点击Show in Explorer)
//使用命令:javadoc - encoding UTF-8 -charset UTF-8 Doc.java
编译JavaDoc步骤
-
找到要编译的类所在的文件夹目录,使用目录方式打开cmd控制台;(右键类,点击Show in Explorer)
-
使用命令:javadoc - encoding UTF-8 -charset UTF-8 Doc.java;
-
打开生成的文件中的首页index.html;
通过IDEA生成JavaDoc步骤
- Tools–>Generate JavaDoc
- 属性输入
- 选择是整个项目、模块还是单个文件;
- 文档输出路径;
- Locale 选择地区,这个决定了文档的语言,中文就是zh_CN;
- 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api.