首页 > 技术文章 > Java帮助文档的制作和使用

benon94 2019-12-06 11:11 原文

一般我们写一些大型项目时,会有多人分工合作负责写不同的类。

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.看成员方法

    A.左边

        是否静态:如果静态,可以通过类名调用

        返回值类型:返回什么,就用什么接收

    B.右边

        看方法名:方法名称不要写错

        参数列表:人家要什么参数,就给什么;人家要几个参数,你就给几个。

推荐阅读