帮助文档的制作

Edit

 

帮助文档的制作

1.要制作帮助文档,其类必须为public或者protected, 其方法必须为public

2.默认的构造函数的权限和所属类一致:
类为public,默认构造函数为public;
类为private,默认的构造函数为private;

3.当一个class文件没有在当前文件夹目录下, 可以在cmd中setclasspath=.; c:\myclass
即在.; 后面接一个class文件地址

4.制作帮助文档

1./**
2.这是一个数组排序的功能
3.@author hubiao
4.@version 1.0
5.*/
6.
7.class ArrayTool
8.{
9.    private ArrayTool()
10.    {
11.        /**
12.        获取一个整形数组的最大值
13.        @param arr 接收一个整形数组
14.        @return 返回该数组最大值
15.        */
16.        public static int getMax(int arr)
17.        {
18.        }
19.    }   
20.}
21.

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

@%2802.Java%29%5Bapi%2C%u5E2E%u52A9%u6587%u6863%5D%0A%23%u5E2E%u52A9%u6587%u6863%u7684%u5236%u4F5C%0A1.%u8981%u5236%u4F5C%u5E2E%u52A9%u6587%u6863%2C%u5176%u7C7B%u5FC5%u987B%u4E3Apublic%u6216%u8005protected%2C%20%u5176%u65B9%u6CD5%u5FC5%u987B%u4E3Apublic%0A%0A2.%u9ED8%u8BA4%u7684%u6784%u9020%u51FD%u6570%u7684%u6743%u9650%u548C%u6240%u5C5E%u7C7B%u4E00%u81F4%3A%0A%u7C7B%u4E3Apublic%2C%u9ED8%u8BA4%u6784%u9020%u51FD%u6570%u4E3Apublic%3B%0A%u7C7B%u4E3Aprivate%2C%u9ED8%u8BA4%u7684%u6784%u9020%u51FD%u6570%u4E3Aprivate%3B%0A%0A3.%u5F53%u4E00%u4E2Aclass%u6587%u4EF6%u6CA1%u6709%u5728%u5F53%u524D%u6587%u4EF6%u5939%u76EE%u5F55%u4E0B%2C%20%u53EF%u4EE5%u5728cmd%u4E2Dsetclasspath%3D.%3B%20c%3A%5Cmyclass%0A%u5373%u5728.%3B%20%u540E%u9762%u63A5%u4E00%u4E2Aclass%u6587%u4EF6%u5730%u5740%0A%0A4.%u5236%u4F5C%u5E2E%u52A9%u6587%u6863%0A%60%60%60java%0A/**%0A%u8FD9%u662F%u4E00%u4E2A%u6570%u7EC4%u6392%u5E8F%u7684%u529F%u80FD%0A@author%20hubiao%0A@version%201.0%0A*/%0A%0Aclass%20ArrayTool%0A%7B%0A%09private%20ArrayTool%28%29%0A%09%7B%0A%09%09/**%0A%09%09%u83B7%u53D6%u4E00%u4E2A%u6574%u5F62%u6570%u7EC4%u7684%u6700%u5927%u503C%0A%09%09@param%20arr%20%u63A5%u6536%u4E00%u4E2A%u6574%u5F62%u6570%u7EC4%0A%09%09@return%20%u8FD4%u56DE%u8BE5%u6570%u7EC4%u6700%u5927%u503C%0A%09%09*/%0A%09%09public%20static%20int%20getMax%28int%20arr%29%0A%09%09%7B%0A%09%09%7D%0A%09%7D%09%0A%7D%0A%0A%60%60%60%0A5.javadoc%20-d%20myhelp%20-author%20-version%20ArrayTool.java%0A%0A