栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

javaSE之文档注释

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

javaSE之文档注释

当需要把自己做好的class文件上传以便他人使用的时候,为了让使用者能够清晰的了解这个程序的情况(文件是干什么用的,内里的方法是什么样的,使用者如何调用)

所以就有了文档注释,因为上传的是后缀名为class的文件,而不是可以编译的java文件,所以文档注释是我们写在java文件中的。

文档注释在java文件中是用来实现的,前面是收尾。

比如,现在有了一个求最大值的程序,为了让使用者能搞清楚情况来调用。如下:

public class Max{        //注意让别人调用必须加public公共化,否则无法生成文档注释相关文件。

public static int max(int[] arr){

int max=arr[0];

for(int i=0;i

if(arr[i]>max){

max=arr[i];

}

}

return max;

}

}

通常文档注释开头先注释文档的说明(干什么的),以及作者和版本(也可不写)。

然后单个方法的文档注释写在该方法的前面(这里只写了一个);

若多个方法注释,比如还有一个求最小值的方法,那就在其方法前再单独文档注释一下。

---------------------------------------------------------

以上这些都写好,开始生成class文件,那使用者是如何调用的呢

调用者打开java安装程序的bin目录,其内有很多exe文件,比如我们之前用的javac.exe编译程序文件,还有运行的java.exe文件等等,

而其中有个javadoc.exe执行程序文件,这个就是用来对文档注释进行提取的程序。

我们可以通过cmd命令行来提取。

首先定位java文件夹的位置,然后输入 ,比如javadoc在E盘java文件夹下

E:java>javadoc -d newDoc -author -version Max.java

其中 -d newDoc 表示把提取的文档注释文件放入一个叫newDoc的文件夹内,若没有这个文件夹,则会自动创建(在这里,d可以理解为download 加载)

后面的依次是表示 作者和版本号也一并提取的意思,最后是文件名

之后就会看到一个newDoc的多网页文件夹,其中index网页内就是提取后的文档注释了。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/991705.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号