Java编写工具类及API文档

发表于 | 分类于 | 阅读次数:
  • 昨天学习了如何编写一个工具类，及如何给他注释再去生成专属于他的API文档。今天我将这个过程以及一些遇到的报错解决整理到博客中。

编写Java工具类（以数组工具类为例）

  • 工具类中包含了一些简单的操作
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    /**
        *这是一个可以对数组进行操作的工具类，该类中提供了如最值获取，排序等功能。
        * @author Orange
        * @version 1.0
        */
       public class ArrayTool {
       
           //
           private ArrayTool(){}
       
           /**
            *获取一个整型数组中的最大值
            * @param  arr 接收一个 int 类型的数组
            * @return 会返回一个该数组中最大值
            */
           public static int getMax(int[] arr){
               selectSort(arr);
               int max = arr[0];
               for(int i=0 ;i<arr.length; i++){
                   if(arr[i]>max)
                       max = arr[i];
               }
               return max;
           }
       
           /**
            * 给int数组进行选择排序。
            * @param arr 接收一个 int 类型的数组
            */
           public static void selectSort(int[] arr){
               for(int i=0 ;i<arr.length-1; i++){
                   int number = arr[i];
                   int index = i;
                   for(int j=i+1;j<arr.length;j++){
                       if(number>arr[j]){
                           number = arr[j];
                           index = j;
                       }
                   }
                   if(index != i)
                       swap(arr,i,index);
               }
           }
       
           //因为 swap 方法是 priavte ，所以只写普通注释就可以了
           //给数组中元素进行位置的置换
           private static void swap(int[] arr,int a,int b){
               int temp = arr[a];
               arr[a] = arr[b];
               arr[b] = temp;
           }
       
           /**
            * 将 int 形式的数组转换成字符串形式。打印形式是[s1,s2,s3,.....]
            * @param arr 接收一个 int 类型的数组
            * @return 返回该 int 数组的字符串表现形式
            */
           public static String ArrayToString(int[] arr){
               String str = "[";
               int point = 0;
               for(int i=0 ;i<arr.length ;i++){
                   if(i != arr.length-1)
                       str = str + arr[i] + ",";
                   else
                       str = str + arr[i] + "]";
               }
               return str;
           }
       }

注释的添加

Java文档注释|菜鸟教程

javadoc工具软件

  • javadoc 语法
  • javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]

DOS界面使用javadoc编写API

  • WIN-R 运行 cmd 进入 DOS 界面
  • 通过使用CMD的命令进入包含该java工具类的文件夹
  • 输入：javadoc -d myhelp -author -version ArrayTool.java

效果展示


报错

编码GBK的不可映射字符

  • 解决方法
    • 关闭编译器要编写的那个工具类
    • 用记事本打开 Java 源文件
    • 另存为，选择 ANSI 编码
    • 覆盖后，在DOS界面重试
    • 成功后，将编码改回原格式

错误2

  • 生成错误原因：改为ANSI编码后，打开了编译器，汉字都变成了乱码
  • 切记，记事本改完编码后，不要。立即用编辑器打开该文件