Java之利用javadoc生成注释文档
来源:互联网 发布:淘宝网贝贝特卖 编辑:程序博客网 时间:2024/06/05 10:55
Java里面可以使用javadoc.exe(与javac.exe 和java.exe在同一个目录下)生成代码的注释文档。这是java特有的小工具。
举个小例子:
Demo.java
/**建立一个用于操作数组的工具类,其中包含着常见的对数组操作的函数如:最值,排序等。@author 张三@version v1.0*/public class ArrayTool{//该类中的方法都是静态的,所以该类是不需要创建对象的,为了保证不让其他人创建该类对象,可以将构造函数私有化。 private ArrayTool(){}/**获取整数数组的最大值@param arr 接受一个元素为int类型的数组@return 该数组的最大元素值。*/public static int getMax(int[] arr){int maxIndex = 0;for(int x = 1; x < arr.length; x++){if(arr[x]>arr[maxIndex])maxIndex = x;}return arr[maxIndex];}/**对数组进行选择排序@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);}}}/**给数组进行元素的位置置换@param arr 接受一个元素为int类型的数组@param a 元素的索引@param b 元素的索引*/private static void swap(int[] arr, int a, int b){if(arr == null)return;if(a < 0 || a >= arr.length)return;if(b < 0 || b >= arr.length)return;int temp = arrp[a];arr[a] = arr[b];arr[b] = temp;}}
如何生成javadoc文档?
然后我们执行javadoc命令:javadoc -d myhelp -author -version ArrayTool.java
简单来说,就是说提取ArrayTool.java代码的注释文档,提取的包含字段为用@author 和@version标示的注释部分,最终保存在myhelp目录下面。
之后,我们可以看到在源代码的同级目录出现了myhelp文件夹,里面包含了注释文档。
打开之后,我们找到index.html文档,打开浏览即可。
注意事项:
1 如果没有myhelp这个目录,会在ArrayTool.java文件所在的目录建立一个myhelp目录。
2 提取的都是公有public的方法,private方法的注释无法提取到文档中。
3 只有 /** */ 格式的注释可以提取出来,但是 /* */和 // 这种格式的提取不出来。
0 0
- Java之利用javadoc生成注释文档
- javadoc生成注释文档
- javadoc生成注释文档
- JAVA 文档注释--JAVADOC文档
- java如何生成doc文档以及javadoc注释
- 利用javadoc生成API文档
- 利用javadoc生成API文档
- javadoc和Java文档注释
- java文档注释与javadoc
- Java - 文档注释(javadoc)
- 为javadoc文档的包生成注释
- javase Javadoc注释和生成文档
- java中生成javadoc文档
- JAVA学习笔记 - javadoc注释文档
- JAVA文档注释----javadoc使用简介
- java注释以及javadoc jar 生成
- java中的注释规范,生成javadoc
- javadoc文档注释
- Oracle登录失败,ORA-01033:ORACLE initialization or shutdown in progress && ORA-00313 无法打开日志组3(用于线程1)的成员……
- 基于FFmpeg的移动端例子:IOS 视频解码器
- Python遍历字典的四种方法对比
- Android RxJava的应用----1
- iOS_抢购倒计时代码备份
- Java之利用javadoc生成注释文档
- spring maven pom.xml参考文件
- shell的简单语法记录
- 十一章 上机练习二
- EEPROM存储器--AT24CXX
- root权限切换
- CSS篇之3. 如何保持浮层水平垂直居中
- 合法整数集-(2)51nod
- wireshark过滤规则