黑马程序员-----java帮助文档的制作

最新推荐文章于 2023-05-27 13:00:14 发布

翻译最新推荐文章于 2023-05-27 13:00:14 发布 · 808 阅读

本文介绍如何使用文档注释为Java类提供详细的说明，并利用javadoc工具生成帮助文档。具体包括如何标注类、方法及参数，以及示例代码。

------- android培训、java培训、期待与您交流！ ----------

java帮助文档的制作

凡是public修饰符修饰的方法都应用文档注释的方法注释，都可以被文档注释工具所提取。
要把一个类生成帮助文档，这个类必须是public修饰！
javadoc用法：
javadoc -d myhelp -author -version ArrayTool.java
其中myhelp是当前目录下的一个文件夹，如果这个文件夹不存在，系统会自动创建。也可以用绝对路径。

下面是例子Demo：
------------------------------------------------------------
开始制作程序的说明书。java的说明书通过文档注释来完成。
*/

/**
这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
@author 张三
@version V1.1

//javadoc -d myhelp -author -version ArrayTool.java

public class ArrayTool
{
/**
空参数构造函数。
*/
private ArrayTool(){}

/**
获取一个整形数组中的最大值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中最大值。
*/
public static int getMax(int[] arr)
{
  int max = 0;
  for(int x=1; x<arr.length; x++)
  {
   if(arr[x]>arr[max])
    max = x;
  }
  return arr[max];
}

/**
获取一个整形数组中的最小值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中最小值。
*/
public static int getMin(int[] arr)
{
  int min = 0;
  for(int x=1; x<arr.length; x++)
  {
   if(arr[x]<arr[min])
    min = x;
  }
  return arr[min];
}
/**
给int数组进行选择排序。
@param arr 接收一个int类型的数组。
*/
public static void selectSort(int[] arr)
{
  for (int x=0; x<arr.length-1 ; x++ )
  {
   for(int y=x+1; y<arr.length; y++)
   {
    if(arr[x]>arr[y])
    {
     swap(arr,x,y);
    }
   }
  }
}
/**
给int数组进行冒泡排序。
@param arr 接收一个int类型的数组。
*/
public static void bubbleSort(int[] arr)
{
  for (int x=0; x<arr.length-1 ; x++ )
  {
   for(int y=0; y<arr.length-x-1; y++)
   {
    if(arr[y]>arr[y+1])
    {
     swap(arr,y,y+1);
    }
   }
  }
}
/**
给数组中元素进行位置的置换。
@param arr 接收一个int类型的数组。
@param a 要置换的位置
@param b 要置换的位置
*/
private static void swap(int[] arr,int a,int b)
{
  int temp = arr[a];
  arr[a] = arr[b];
  arr[b] = temp;
}
/**
用于打印数组中的元素。打印形式是：[elemet1, element2, ...]
*/
public static void printArray(int[] arr)
{
  System.out.print("[");
  for(int x=0; x<arr.length; x++)
  {
   if(x!=arr.length-1)
    System.out.print(arr[x]+", ");
   else
    System.out.println(arr[x]+"]");
  }
}
}