在Java基础学习中，编写了很多代码，虽然很基础，但是为了在日后方便查看，想定义一个API，就像jdk文档形式的，不知道该如何定义，请教前辈们，你们有没有弄过啊？

尝试过用javadoc生成，但是那样的话生成的只是单个的类的文档，想知道如何把所有的都集中到一个API中

为什么没有人肯帮帮忙呢？:'(

1. 在DOS下使用  //javadoc -d myhelp -author -version ArrayTool.java   
   
2. ArrayTool.java 是表明要把哪个java文件生成文档， 一般都是工具类才要生成文档，工具类的方法上都要加上文档注释才能生成。
   
3. 比如
   
4. /**
   
5. 这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
   
6. @author JiangShanShan
   
7. @version V1.0
   
8. 
   
9. */
   
10. public class ArrayTool {
    
11.         /**
    
12.         空参数构造函数。
    
13.         */
    
14.         private ArrayTool(){};//防止别人new对象
    
15.         /**
    
16.         获取一个整形数组中的最大值。
    
17.         @param arr 接收一个int类型的数组。
    
18.         @return 会返回一个该数组中最大值。
    
19.         */
    
20.         //获取最大值
    
21.         public static int getMax(int arr []){//一定要加上static，对方通过类名调用该方法，在创建对象之前，所以必须得定义成静态的
    
22.                 int maxIndex = 0;//定义变量，记录最大值的角标
    
23.                 for(int x=0;x<arr.length;x++){//要想挨个比值，必须先循环遍历拿出数组里的值，所以先遍历后比较
    
24.                         if(arr[x]>arr[maxIndex])
    
25.                         maxIndex = x;
    
26.                                                
    
27.                 }               
    
28.                 return arr[maxIndex];
    
29.         }
    
30.         /**
    
31.         获取一个整形数组中的最小值。
    
32.         @param arr 接收一个int类型的数组。
    
33.         @return 会返回一个该数组中最小值。
    
34.         */
    
35.         //获取最小值
    
36.         public static int getMin(int arr[]){
    
37.                 int minIndex = 0;
    
38.                 for(int x=0;x<arr.length;x++){
    
39.                         if(arr[x]<arr[minIndex])
    
40.                                 minIndex = x;
    
41.                 }
    
42.                 return arr[minIndex];
    
43.         }
    
44.        
    
45.         /**
    
46.         给int数组进行选择排序。
    
47.         @param arr 接收一个int类型的数组。
    
48.         */
    
49.         //选择排序
    
50.         public static void selectSort(int arr []){//给数组排序，没有返回值
    
51.                 for(int x=0;x<arr.length-1;x++){
    
52.                         for(int y=x+1;y<arr.length;y++){
    
53.                                 if(arr[x]>arr[y])
    
54.                                         changePosition(arr,x,y);
    
55.                         }
    
56.                        
    
57.                 }
    
58.                
    
59.                
    
60.                
    
61.         }

复制代码

楼主，或许你跟我以前想的一样，
一个java原文件里面，有很多个class，你想用javadoc工具，
把它们全都放到一个API文档里面？

你可以这样写：
javadoc -private -d ZhuShi ZhuShi.java

只要加上private，那么这个java文件里面的类，都会在生产的文档中显示出来。

——————————————————————————————————————————
再复杂一点的用法：

• 三个java源文件：ZhuShi.java  、print.java 、 HelloWorld.java
• 位于两个包： com.itheima1   、 com.itheima2
• 其中一个java文件中含有三个类：   ZhuShi.java中，有ZhuShi、print1、print2三个类
  

1. package com.itheima1;
   
2. public class ZhuShi
   
3. {
   
4.         /**
   
5.         * ZhuShi类的main方法
   
6.         * @param args 传入的参数
   
7.         * @return 返回空值
   
8.         */
   
9.         public static void main(String[] args){
   
10.                         System.out.println("HelloWorld!");//单行注释
    
11.         }
    
12. }
    
13. 
    
14. 
    
15. class print1
    
16. {        /**
    
17.         * print1类
    
18.         * @param s 传入的参数
    
19.         * @return 返回空值,打印
    
20.         */
    
21.         public void print(String s){
    
22.                         System.out.println(s);//单行注释
    
23.         }
    
24. }
    
25. 
    
26. 
    
27. class print2
    
28. {        /**
    
29.         * print2类
    
30.         * @param s 传入的参数
    
31.         * @return 返回空值,打印
    
32.         */
    
33.         public void print(String s){
    
34.                         System.out.println(s);//单行注释
    
35.         }
    
36. }

复制代码

其它两个文件就不贴了，
用的命令行：

javadoc -private -d ZhuShi ZhuShi.java print.java HelloWorld.java

文档就会生成出这个样子，

linweiwen 发表于 2014-4-24 21:51
楼主，或许你跟我以前想的一样，
一个java原文件里面，有很多个class，你想用javadoc工具，
把它们全都放到 ...

恩 ， 恩，就是这样，我试试，谢谢！

姜姗姗 发表于 2014-4-24 21:20

这样是单个类的文档，不过同样谢谢！

有个jd2chm.exe工具，自动生成.chm文档我的这个blog 里面有讲解http://blog.csdn.net/yuanhenglizhen110/article/details/9245737

元亨利贞 发表于 2014-4-24 23:12
有个jd2chm.exe工具，自动生成.chm文档我的这个blog 里面有讲解http://blog.csdn.net/yuanhenglizhen110/ar ...

谢谢，我看了，试试

我也是来学习的，我也想知道

1. /*
   
2.    文档注释
   
3. */
   
4. 
   
5. /**
   
6. 此类是对数组进行取最值排序等操作的
   
7. @author 张三  
   
8. @version 1.0
   
9. */
   
10. public class ArrayOperate{
    
11.         private ArrayOperate(){}//将构造函数私有化，否则提取中会默认有构造器和说明
    
12.         /**
    
13.         取int数组里面的最大值
    
14.         @param arr 传入一个int数组
    
15.         @return 返回一个int数值
    
16.         */
    
17.         public static int max(int[] arr){
    
18.                 int max=arr[0];
    
19.                 for(int i=0;i<arr.length;i++){
    
20.                         if(arr[i]>max){
    
21.                         max=arr[i];
    
22.                         }
    
23.                 }
    
24.                 return max;
    
25.         }
    
26.         /**
    
27.         取int数组里面的最小值
    
28.         @param arr 传入一个int数组
    
29.         @return 返回一个int数值
    
30.         */
    
31.         public static int min(int[] arr){
    
32.                 int min=arr[0];
    
33.                 for(int i=0;i<arr.length;i++){
    
34.                         if(arr[i<min]){
    
35.                         min=arr[i];
    
36.                         }
    
37.                 }
    
38.                 return min;
    
39.         }
    
40. 
    
41.         /**
    
42.         对传入的int数组里面进行冒泡排序
    
43.         @param arr 传入一个int数组
    
44.         */
    
45.         public static void maoSort(int[] arr){//冒泡排序
    
46.                 for(int i=0;i<arr.length-1;i++){
    
47.                         for(int j=0;i<arr.length-1;i++){
    
48.                         replace(arr,j,j+1);
    
49.                         }
    
50.                 }
    
51. 
    
52.         }
    
53.         /**
    
54.         对传入的int数组里面进行选择排序
    
55.         @param arr 传入一个int数组
    
56.         */
    
57.         public static void xuanzeSort(int[] arr){//选择排序
    
58.                 for(int i=0;i<arr.length-1;i++){
    
59.                         for(int j=i+1;j<arr.length;j++){
    
60.                                 replace(arr,i,j);
    
61.                         }
    
62.                 }
    
63.         }
    
64.         //私有化方法无需注释，也无法注释
    
65.         private static void replace(int[] arr,int a,int b){
    
66.                 if(arr[a]>arr[b]){
    
67.                         int t=arr[a];
    
68.                         arr[a]=arr[b];
    
69.                         arr[b]=t;
    
70.                 }
    
71.         }
    
72. 
    
73. }
    
74. /*
    
75. 以上完成后 在命令中进提取
    
76. 如E：\java 目录下  //创建目录，作者，版本
    
77. E:\java>javadoc -d这个是dir的缩写意思是创建
    
78. Mydoc这个是创建文件夹 -author这个是作者   
    
79. -version这个是版本   ArrayOperate.java最后跟上你的java文件名.java
    
80. 
    
81. E:\java>javadoc -d Mydoc -author -version ArrayOperata.java       
    
82.                                                         
    
83. */
    
84. 
    
85. //提取成功后打开  index.html查看
    
86. 
    
87. 
    
88. 
    

复制代码

好东西，要收藏啊！！！

小马初长成 发表于 2014-4-25 16:26

请问子啊eclipse中如何生成对应的API呢？

linweiwen 发表于 2014-4-24 21:51
楼主，或许你跟我以前想的一样，
一个java原文件里面，有很多个class，你想用javadoc工具，
把它们全都放到 ...

总结的好，鼓掌

linweiwen 发表于 2014-4-24 21:51
楼主，或许你跟我以前想的一样，
一个java原文件里面，有很多个class，你想用javadoc工具，
把它们全都放到 ...

那用eclipse怎么生成呢？