黑马程序员技术交流社区

标题: 终于会制作自己的java说明书(帮助文档)了 [打印本页]

作者: 孙万利 时间: 2012-11-26 01:02
标题: 终于会制作自己的java说明书(帮助文档)了
今天真的很高兴，可以说兴奋，以前就不会，不知道，今天终于知道了帮助文档如何生成的了； {:soso_e192:}
java的说明书(帮助文档)通过文档注释来完成

要生成帮助文档，类必须是public 修饰
生成帮助文档使用到bin目录下javadoc编译  格式：  javadoc -d 目录名(c: d: ...) 文件夹名(如果没有会自动生成) -author -version java文件
以此为例在默认目录下生成帮助文档： javadoc  -d(如果不写默认为当前目录)  helpdoc -author -version ArrayTool.java
            在c盘下生成帮助文档             javadoc  -d c:\helpdoc -author -version ArrayTool.java
要想出现空的构造函数在帮助文档里，就要把修饰符变成public

  以后只要把帮助文档和编译生成.class文件发给使用方，即可使用，又安全(不用知道你源码如何编写的)

下面通过代码和截图说明

/**
文档注释
这是一个可以对数组进行操作的工具类，该类中提供了了，获取最值，排序等功能
@author 孙万利
@version v1.1
*/

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 SearchSort(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);

}

}

  }

}

//对排序中的重复代码（比较部分）进行封装
// 只对本类中排序方法使用,不对外提供，进行private 私有化

/**

给数组中元素进行位置的置换
@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;

}

  //封装一个对数组进行遍历的方法
/**

用于打印数组中的元素，打印形式是【element1,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]+"]");

         }
      }
}
}

doc2.gif (847.45 KB, 下载次数: 40)

doc1.gif (904.44 KB, 下载次数: 34)

doc.jpg (77.7 KB, 下载次数: 35)

作者: 李龙祺 时间: 2012-11-26 14:23
{:soso_e179:}

作者: 冰深 时间: 2012-11-27 12:29
很不错~

作者: peng84 时间: 2016-11-6 00:46
不错，我现在还不会呢

欢迎光临黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2