JAVA文档注释
2017-09-28 10:34
141 查看
JAVA源码中注释方式有3种
其中第三种注释为文档注释,可以使用javadoc指令生成帮助文档。
控制台下,使用javadoc方法生成帮助文档
![](https://img-blog.csdn.net/20170928102931239?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvSnVseV9j/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
生成的文件
![](https://img-blog.csdn.net/20170928103104552?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvSnVseV9j/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
打开 index.html 文件
![](https://img-blog.csdn.net/20170928103404844?waterma<br/>91e2<br/>rk/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvSnVseV9j/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
![](https://img-blog.csdn.net/20170928103413464?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvSnVseV9j/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast)
// /* */ /** */
其中第三种注释为文档注释,可以使用javadoc指令生成帮助文档。
/** 一个文档注释的测试类 @author BakingJuly @version v1.0 */ //方便起见,方法体已省略 public class Doc { /** 用于给数组进行元素置换 @param arr 接受一个整型数组 @param a 要进行置换的第一个元素下标 @param b 要进行置换的第二个元素下标 */ private static void swap(int[] arr,int a,int b){} /** 获取整形数组最大值。 @param arr 接受一个整型数组 @return 该数组的最大值 */ public static int getMax(int[] arr){return 0;} /** 对数组进行选择排序 @param arr 接受一个整型数组 */ public static void selectSort(int[] arr){} /** 将整型数组转换为字符串 @param arr 接受一个整型数组 @return 返回该整型数组的字符串形式 */ public static String arrToString(int[] arr) { String a=""; return a; } }
控制台下,使用javadoc方法生成帮助文档
生成的文件
打开 index.html 文件
相关文章推荐
- Java文档注释【自制API】
- JAVA文档注释小结
- Java文档注释摘要
- java文档注释
- 知识学习——Java文档注释
- java学习笔记(四)----对象、数组作为参数传递,静态变量、静态方法的使用,内部类,使用文档注释
- JAVA文档注释----javadoc使用简介
- Java 注释和嵌入式文档
- 注释文档 -Java
- JAVA文档注释小结
- 在java源码中为Javadoc编写文档注释(1)
- 黑马程序员_Java基础 数组、数组工具类、文档注释总结
- 黑马程序员_java文档注释
- Java注释写好了,如何提取出来生产说明文档呢?
- 黑马程序员——Java基础之面向对象(二)文档注释与设计模式
- Java 文档&注释 -Java学习笔记(32)
- Java经验点滴:类注释文档编写方法
- 如何写Java文档注释(Java Doc Comments)
- java基础第一讲——JDK、注释、帮助文档、编码规范
- Java文档注释