黑马程序员技术交流社区

标题: 请大家帮忙看下这个问题....谢谢！ [打印本页]

---

作者: 杜成龙    时间: 2013-4-15 09:43
标题: 请大家帮忙看下这个问题....谢谢！


程序如下：
/*
这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
@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 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;
  arr=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]+"]");
  }
}
}
生成的说明书如下：

类 ArrayTool

• java.lang.Object
• 
  
  
  
  • ArrayTool
    

• ---

  
  public class ArrayToolextends java.lang.Object
  

• 
  
  
  
  • 方法概要 方法 限定符和类型方法和说明
    static void[url=file:///E:/EditPlus%203/file/inst/ArrayTool.html#bubbleSort(int[])]bubbleSort[/url](int[] arr)
    static int[url=file:///E:/EditPlus%203/file/inst/ArrayTool.html#getMax(int[])]getMax[/url](int[] arr)
    static int[url=file:///E:/EditPlus%203/file/inst/ArrayTool.html#getMin(int[])]getMin[/url](int[] arr)
    static void[url=file:///E:/EditPlus%203/file/inst/ArrayTool.html#printArray(int[])]printArray[/url](int[] arr)
    static void[url=file:///E:/EditPlus%203/file/inst/ArrayTool.html#selectSort(int[])]selectSort[/url](int[] arr)
    
    
    
    • 从类继承的方法 java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      
    
    
  
  

• 
  
  
  
  • 方法详细资料
    
    
    
    • getMaxpublic static int getMax(int[] arr)
      
    
    
    • getMinpublic static int getMin(int[] arr)
      
    
    
    • selectSortpublic static void selectSort(int[] arr)
      
    
    
    • bubbleSortpublic static void bubbleSort(int[] arr)
      
    
    
    • printArraypublic static void printArray(int[] arr)
      
    
    
  
  

我想请问为什么生成的说明书中没有参数和返回值等文字说明？请大家指点一下，谢谢啦~~

---

作者: HM刘俊    时间: 2013-4-15 10:33
你确定你那样写出来的代码能生成javadoc?
标准格式应该是;
/**
*这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
*@author 张三
*@version V1.1
*/

---

作者: 杜成龙    时间: 2013-4-15 12:45

HM刘俊 发表于 2013-4-15 10:33
你确定你那样写出来的代码能生成javadoc?
标准格式应该是;
/**

可以的，我试过，生成的就是上面的结果，我发现只要注释前面是/**的话就对了，但如果只有一个*，像这样
/* 就生成上面的结果，不知是什么原因？

---

作者: HM刘俊    时间: 2013-4-15 19:48

杜成龙 发表于 2013-4-15 12:45
可以的，我试过，生成的就是上面的结果，我发现只要注释前面是/**的话就对了，但如果只有一个*，像这样
/ ...

可能就是书写的规范问题吧。

---

作者: 山西_李帅    时间: 2013-4-15 20:23
javadoc格式应该是;                     
/**
*这里呢写你次类的作用，里面提供了什么方法和功能。
*@author 张
*@version java1.5
*/

1，必须是文本注释。
2, @author    这里是作者
3，@version   这里是版本

---

作者: 黄玉昆    时间: 2013-4-17 08:41
如果问题未解决，请继续追问，如果没有问题了，请将帖子分类 改为“已解决”，谢谢

---

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

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