Java帮助⽂档的制作和使⽤⼀般我们写⼀些⼤型项⽬时,会有多⼈分⼯合作负责写不同的类。
1.其中包含main⽅法的类叫做测试类
测试类的作⽤:创建其他类的对象,并调⽤其他类的功能。
2.包含了详细步骤的⽅法都放在⼀个类中,这个类叫做功能类
功能类的作⽤:⽤来存放相关功能的操作。
⼤家分⼯合作的时候,别⼈给我们的⽂件⼀般都会是class⽂件,⽽不是java⽂件。
因为class⽂件是看不到源代码的,这样⼀来,你根本不知道别⼈的功能类⾥的源代码是怎么写的。为了更好的使⽤别⼈的class⽂件,⼀般会制作⼀个说明书,⽤于讲解功能类中各个⽅法的使⽤步骤。
如何制作⼀个说明书?
1.写⼀个功能类
2.对这个类中的⽅法加⼊⽂档注释
3.⽤⼯具解析⽂档注释(javadoc⼯具)
⼯具使⽤格式:javadoc -d ⽬录 -auther -version 功能类名.java
注释⽂档的书写格式:第⼀⾏开头使⽤/**,最后⼀⾏使⽤*/,中间每⼀⾏开头使⽤*
/**
*
*
*/
注意事项:1.功能类需要⽤public修饰,否则没有权限访问;
2.有参数的⽅法必须使⽤"@param ⽅法名"来注释;
3.有返回值的⽅法必须使⽤"@return"来注释。
使⽤说明书:到上⾯⽬录所在位置,使⽤浏览器打开index.html⽂件。
使⽤帮助⽂档:
标准的帮助⽂档⼀般都是chm格式,具体使⽤步骤如下:
1.直接打开chm格式的帮助⽂档。
2.点击“显⽰”,打到“索引”,看到输⼊框。
3.输⼊要查的名字,⽐如Scanner。
4.看包的名称:如果是java.lang包下的类就不需要导⼊,其他的包均需要导⼊。
Scanner类是java.util包下的类,需要导⼊:java.util.Scanner。
5.看类的解释和说明,还有类的使⽤版本,不同的jdk版本能使⽤的类不同。
6.看类的结构:
成员变量 字段摘要
构造⽅法 构造⽅法摘要
成员⽅法 ⽅法摘要
7.学习构造⽅法
A.有构造⽅法,就创建对象
B.没有构造⽅法,成员可能都是静态的
8.看成员⽅法java创建文件
A.左边
是否静态:如果静态,可以通过类名调⽤
返回值类型:返回什么,就⽤什么接收
B.右边
看⽅法名:⽅法名称不要写错
参数列表:⼈家要什么参数,就给什么;⼈家要⼏个参数,你就给⼏个。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论