本篇文章主要介绍java的包机制和javaDoc的概念,内容比较易懂,主要是为了让初学者们更好的去规范代码,夯实基础,以后在学习中和工作中都会形成一个好的习惯。
我们用百度的地址来举例说明一下(www.baidu.com)
1、首先,将百度地址倒置,com.baidu.www,然后打开Idea工具,右键项目中的src。
2、大家可以看到新建中,有软件包这个选项,软件包就是文件夹。
3、将上述倒置后的地址,输入进去。
4、按回车后,我们在右侧就可以看到自动生成的包结构。
5、我们可以通过选项设置,来设置包的伸缩,现在大家看到的是com.baidu.www,我们设置以后,会将这三段拆分为三个包,如下图。
6、包的引用和导入
package com.baidu.www;
public class Demo {
}
package com.baidu.www;
import base.Demo;
public class Demo {
}
javaDoc文档注释,在最开始的关于java的注释中有说到过。
package base;
/**
* @author 落满樱花的羊
* @version 1.0
* @since 1.8
*/
public class DOC {
}
package base;
public class DOC {
String name;
//定义一个方法
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name)throw Exception{
return name;
}
}
总结一下,文档注释中的内容有
1、@author 作者名字
2、@version 版本号
3、@since JDK版本
4、@param 参数名字
5、@throw 抛出异常
6、@return 返回值
大家一定要去搜素文档来查阅,虽然不用全部都了解,但是用的时候可以根据帮助文档去更好的理解一些地方
JDK帮助文档 在度娘搜索就可以找到。
我们可以自己生成一个JDK文档来查阅。
1、首先我们找到我们类所在的文件夹,然后在上方路径中输入cmd进入Dos窗口。
2、输入命令javadoc -enCoding UTF-8 -charset UTF-8 Demo.java
3、输入后,大家可以看到这样的页面。
4、我们可以看到一个叫 index.html 的文件,这个文件就是生成的帮助文档。
5、我们回到刚刚的文件夹,发现现在文件夹的内容多了很多。
6、我们打开一下这个文件,就可以进入到帮助文档中查看信息了。
7、我们这种生成方式呢,是了解一下原始生成文档的方式,我们下面介绍一下如何用Idea工具直接生成帮助文档。
Idea—>工具—>生成JavaDoc 点击后即可生成。
以上内容和前面的所有文章,就是介绍了java的基础知识,大家可以去反复看看以前的文章,多去练习!
1、java第一个程序Hello,World!
2、java的运行机制
3、关于java的注释
4、关于java的关键字和标识符
5、关于java数据类型及变量
6、关于java数据类型拓展
7、关于java的类型转换
8、关于java的变量
9、关于java所有运算符的详细说明
俗话说的好,不敲坏几个键盘,成为不了一个优秀的程序猿!!