JAVA基础6.41——JAVA文档注释
来源:互联网 发布:linux版安卓模拟器 编辑:程序博客网 时间:2024/05/21 19:46
当我写了一个ArrayOperate类(对数组进行操作,查找并返回最大值和最小值)之后,我可以共享我的ArrayOperate.class给别人使用。
但是别人并不知道我的类里面有什么函数,也不知道该怎么用,这时候我们就需要写一个注释来告诉他,让他一目了然。
/**此类是对数组进行取最值,排序等操作的@author QiaoPeichen@version 1.0*/public class ArrayOperate{private ArrayOperate(){}/**取int数组里的最大值@param arr 传入一个int数组@return 返回一个int数值*/public static int max(int[] arr){//求最大值int max=arr[0];for(int i=0;i<arr.length;i++){if(arr[i]>max){max=arr[i];}}return max;}/**取int数组里的最小值@param arr 传入一个int数组@return 返回一个int数值*/public static int min(int[] arr){//求最小值int min=arr[0];for(int i=0;i<arr.length;i++){if(arr[i]<min){min=arr[i];}}return min;}}以上就是JAVA文档注释,@param标明了参数是arr,@return标明了 返回一个int数值 ,@author 标明了作者,@version标明了当前版本号。(这些都会在文档里根据你当时的注释原样自动显示出来)。
和普通的注释/* */不同,文档注释开头多了一个*变成了/** */。
文档已经注释好了,接下来我要通过javaJDK中的javadoc.exe来提取该class中的文档注释。
D:\>javadoc -d Mydoc -author -version ArrayOperate.java
以上是在cmd中打出的命令。
进入对应class的盘符,然后打出javadoc(和javac的使用是一个意思) -d Mydoc(提取出来的注释被放在Mydoc中,如果没有该文件,则创建该文件) -author -version(提取作者和版本号) ArrayOperate.java(对应被提取的文件)。
生成结果:
正在创建目标目录: "Mydoc\"
正在加载源文件ArrayOperate.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.7.0_75
正在构建所有程序包和类的树...
正在生成Mydoc\ArrayOperate.html...
正在生成Mydoc\package-frame.html...
正在生成Mydoc\package-summary.html...
正在生成Mydoc\package-tree.html...
正在生成Mydoc\constant-values.html...
正在构建所有程序包和类的索引...
正在生成Mydoc\overview-tree.html...
正在生成Mydoc\index-all.html...
正在生成Mydoc\deprecated-list.html...
正在构建所有类的索引...
正在生成Mydoc\allclasses-frame.html...
正在生成Mydoc\allclasses-noframe.html...
正在生成Mydoc\index.html...
正在生成Mydoc\help-doc.html...
进入对应盘符,找到Mydoc 点开index.html 就看到这个了。
- JAVA基础6.41——JAVA文档注释
- java基础(1)文档注释
- Java基础——注释
- Java基础学习总结(48)——Java 文档注释
- 知识学习——Java文档注释
- 每天学点java—文档注释
- java基础第一讲——JDK、注释、帮助文档、编码规范
- 虽然微不足道但是很有用的JAVA基础—注释与文档标记
- Java基础--->02.单行注释、多行注释,文档注释和API文档。
- Java注释及文档注释
- JAVA 文档注释
- java文档注释
- java文档注释
- Java文档注释说明
- java注释文档
- Java文档注释方法
- Java 文档注释
- java文档注释
- angularjs2 二
- activity生命周期详解
- 第二周项目0 宣告‘主权’
- POJ 3928 Ping pong(树状数组)
- 欢迎使用CSDN-markdown编辑器
- JAVA基础6.41——JAVA文档注释
- 向量
- android webview 自定义404错误页面!
- Android 之MediaPlayer播放背景音乐
- Myeclipse如何使用自带git工具向远程仓库提交代码
- 每日小记(16 .9.7)
- 迷宫:广度优先搜索求最短路径
- 点击事件与屏幕溢出判断
- spring中配置数据源的4种形式