1. /*
   
2. java说明书的生成使用jdk中的javadoc工具
   
3. 
   
4. 生成说明书的规则:
   
5. 1,类必须用public修饰
   
6. 2,类的成员只有public,protected修饰的成员才会在说明书中打印
   
7. 3,public内部类也行
   
8. 
   
9. 说明书的cmd生成：
   
10. javadoc -d my -author -version Document.java
    
11. -d my: 将生成的说明说存放在my文件夹中,如果当前目录中没有my文件夹将自动生成
    
12. -author：编写者（可有可无）
    
13. -version: 版本号（可有可无）
    
14. */
    
15. package com;
    
16. import java.io.BufferedWriter;
    
17. /**
    
18. 这是一个java说明书制作事例
    
19. @author  zzh   //作者
    
20. @version  v1.0  //版本
    
21. */
    
22. public class Document//制作说明书类必须是最高权限public
    
23. {
    
24.         /**
    
25.          int型成员变量
    
26.          **/
    
27.         public int a;
    
28.         /**
    
29.          int型成员变量
    
30.          **/
    
31.         protected int b;
    
32.         /**
    
33.          int型成员变量
    
34.          **/
    
35.         private int c;
    
36.         /**
    
37.          int型成员变量
    
38.          **/
    
39.         public static int d;
    
40.         /**
    
41.          无参构造方法
    
42.          */
    
43.         public Document(){}
    
44.         /**
    
45.          获取一个最大值
    
46.          @param arr  接收一个int型数组
    
47.          @return 返回一个最大值
    
48.          */
    
49.         public static int Max(int[] arr){return 0;}
    
50.         /**
    
51.          获取一个最大值
    
52.          @param arr 接收一个字符型数组
    
53.          return 返回一个最大值
    
54.          */
    
55.         protected static int Max(char[] arr){return 0;}
    
56.         /**
    
57.          显示功能
    
58.          @param a 接收一个int型数
    
59.          @param b 接收一个int型数
    
60.          */
    
61.         public static void show(int a,int b){}
    
62.         /**
    
63.          显示功能
    
64.          */
    
65.         private void show(){}
    
66.         /**
    
67.          显示功能
    
68.          */
    
69.         public void show1(){}
    
70.         /**
    
71.          内部类
    
72.          **/
    
73.         public class inner
    
74.         {
    
75.         }
    
76. }
    
77. /**
    
78. 这是一个java说明书制作事例
    
79. */
    
80. class Document1 //在说明书中不会显示
    
81. {
    
82.         /**
    
83.          无参构造函数
    
84.          */
    
85.         public Document1(){}
    
86.         protected static int Max(char[] arr){return 0;}
    
87.         /**
    
88.          显示功能
    
89.          @param a 接收一个int型数
    
90.          @param b 接收一个int型数
    
91.          */
    
92. }

复制代码

这昨天才讲完