编写一个数组工具类, 编写本软件的 帮助文档(API文档)


本文档是对静态成员的练习。
一、
    建立一个ArrayTool(数组工具)的类,在此类中对传入数组进行一些操作(选最大值、先最小值、冒泡排正序、选择排反序、输出数组元素),
二、
    建立一个Test的类,建立一个数组对上述的工具进行调用。
三、
    发现,当工具方法都是动态的时候,虽然所有的工具函数都没有用到工具类中的成员数据,而且ArrayTool中也没有封装成员数据,
  但是在使用之前还是要先创建一个ArrayTool类,如此比较麻烦,
  于是将ArrayTool类中的所有函数都 使用static修饰(变成静态方法),在使用这些函数的时候就可以不用创建新的对象而直接使用了。
四、
    发现,此时虽然我的工具不用创建对象也可以直接使用了,但是此时还是可以创建该类对象(此举多余)。
  所以,将ArrayTool类中的构造函数私有化(private),彻底封装此类。(优化内存)

五、
    通过文档注释来生产本程序的软件说明书(API)。
    定义符号:文档注释符。


    注      意:只有被public修饰的类才能创建帮助文档,也只有被public注释的方法才能被 文档注释提取。

    操      作: 1、当写好文档注释后,在命令提示行输入: javadoc -d myhellp -author -version ArrayTool.java
                        (表:在当前目录下 新建或者查找 myhellp 文件夹进行存储, 并且创建作者和版本信息, 被创建的文件名)

           使用符号:/**........注释内容......................*/

当此类不是public的时候   运行时报错。

当类名之前加上public后

原文地址:https://www.cnblogs.com/soficircle/p/6607434.html