包机制
-
为了更好的组织类,java提供了包机制,用于区别类名的命名空间。
-
包语法的语法格式为:
package pkg1[.pkg[.pkg...]] //这句话必须放在程序的第一行,不然要报错
-
一般利用公司的域名倒置作为包名:如www.baidu.com---->com.baidu.www
-
为了能够使用某一个包的成员,我们需要在java程序中明确导入该包。使用“import”语句可完成此功能
import package[.package2...].(classname|*);//import导入语句不允许放在package上面. //扩展 //如果导入的包有很多很多的类一个个导入入太麻烦可以这样做: import com.dai.operator.*;//最后这个*叫通配符,代表包里的所有类全部导入。
这边可能会出现创建包没有分层的问题:
第一步点击project的边上的设置,第二步把compact middle packages取消勾选,就可以解决包没有分层的问题啦。
Java Doc
- Javadoc命令是用来生成自己API文档的
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
package com.dai.base;
//文档注释在类之外的叫类注释,注释在类之内的叫方法注释
/**
* @author Daibinbin
* @version 1.0
* @since 1.8
*/
public class JavaDoc {
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
-
通过命令行 输入javadoc命令生成API文档:
- 在idea中打开JavaDoc这个类所处的位置JavaDoc右键找到Open in Explorer(知道文件放在那里的可以忽略这一步),在文件中的命令行盘前输入cmd 打开DOS命令。
- 输入javadoc -encoding UTF-8 -charset UTF-8 JavaDoc.java
- 在idea中打开JavaDoc这个类所处的位置JavaDoc右键找到Open in Explorer(知道文件放在那里的可以忽略这一步),在文件中的命令行盘前输入cmd 打开DOS命令。
-
通过idea生成API文档:
- 点击要生成的类的文档(JavaDoc),在最上方的菜单栏中找到Tools。
- 在Tools中选择Generate JavaDoc,会出现一个Generate JavaDoc小界面。
- 选择whole project
- 设置导出路径
- 输入-encoding UTF-8 -charset UTF-8(防止文档乱码)
-
选择whole project
- 设置导出路径
- 输入-encoding UTF-8 -charset UTF-8(防止文档乱码)