文档注释,建立解释文档
2015-08-19 12:21
232 查看
刚刚学习有关如何建立一个有关数组的文档工具,觉得这个有一定的意义。这种功能可能也就是有关java语言的可移植性。首先要写一个自己想要的程序(文档)用来实现自己想要的有关功能,然后把这个文档的class文档发过给别人,当然也就可以用来开发(重要用途)。这种文档实用而且有一定的价值,不过class是字节码文件,发过来别人也看不懂。那么怎么样才可以看懂呢?那就是写一个有关这个文档的注释文档,现在用B表示。下面是有关如何建立“一个文档A”(class字节码文档)和有关这个文档用法的注释”文档B"的方法。(这样就可以移植了,简单的说就是只要你把这二个东西发给其他人,这个人就可以通过文档注释了解这个class的主要功能,对方也就可以使用了)
第一步:
首先做一个自己想要的文档(有关java代码的工具),包括要实现功能的代码。然后重点的来了,就是写好有关文档的注释(注意关键字:@,param,author,return等等的使用,方便使用者了解A文档的功能)。这些注释会通过javadoc这个java工具”翻译“出来,就是在B中会出现对A文档的功能解释。
第二步:
自己写好一个主函数文档(只要调用到A文档就可以),调试A的源代码文档(A的java文档),得到A的class文档,就是A文档了。
第三步:
打开计算机的控制台,打开javaDoc看看,里面有很多功能。不用记住,最好有个大概的了解。一般会使用到(-author,-version,-d,等等)几个功能。然后在控制台上打这几个代码
:javac -d myhelp -author -version "A文档名"(不是一定这样的,这只是比如。你可以自己加上一些功能)这样就可以得到Aclass文档的解释文档 “myhelp”(这个可以自己命名的,在刚刚那个代码位置修改就可以)打开""myhelp"文档里面有一个叫“index.html”的文件,这个就是B文档了。里面有其他的文件可以不用管,打开看看也可以。
使用它了:
现在就有了A的class文档和对应的注释文档B了,就知道对方给自己的东西是用来干嘛的(自己不用知道A的源代码是怎么实现的,直接拿来用就可以,里面的东西可能是自己不会的)这个你就可以自己写一个自己的主函数文档,看着B就知道可以实现什么东西(比如这是个有关数组的排序,最大值的函数包文档),你就调用函数(B里面注释好了,对应功能在A文案的class中实现)。这样就是实现了你要做的事情。不用自己写程序,直接拿别人的来用就可以。比如你不会学实现数组排序的函数,不要紧。让老师给你个文档注释A和B(解释A功能)你就可以在你的主函数中无压力实现你要的功能了。
注意事项:
1,最好把A,B文档和你自己的主函数文档放在一个区(比如都在C盘的第一个界面),不然就有点麻烦。(反正现在我不会这个)
2,如果你存放文档的盘和控制台的盘(默认好像是C盘)不是一个盘的话。你可以把文档重新放到C 盘。或者可以使用指令改变控制台的盘(我不会写,百度上有)。
3,自己一边看一边动手比较好。比如你会觉得我写的东西很复杂,其实我觉得很清楚了。
第一步:
首先做一个自己想要的文档(有关java代码的工具),包括要实现功能的代码。然后重点的来了,就是写好有关文档的注释(注意关键字:@,param,author,return等等的使用,方便使用者了解A文档的功能)。这些注释会通过javadoc这个java工具”翻译“出来,就是在B中会出现对A文档的功能解释。
第二步:
自己写好一个主函数文档(只要调用到A文档就可以),调试A的源代码文档(A的java文档),得到A的class文档,就是A文档了。
第三步:
打开计算机的控制台,打开javaDoc看看,里面有很多功能。不用记住,最好有个大概的了解。一般会使用到(-author,-version,-d,等等)几个功能。然后在控制台上打这几个代码
:javac -d myhelp -author -version "A文档名"(不是一定这样的,这只是比如。你可以自己加上一些功能)这样就可以得到Aclass文档的解释文档 “myhelp”(这个可以自己命名的,在刚刚那个代码位置修改就可以)打开""myhelp"文档里面有一个叫“index.html”的文件,这个就是B文档了。里面有其他的文件可以不用管,打开看看也可以。
使用它了:
现在就有了A的class文档和对应的注释文档B了,就知道对方给自己的东西是用来干嘛的(自己不用知道A的源代码是怎么实现的,直接拿来用就可以,里面的东西可能是自己不会的)这个你就可以自己写一个自己的主函数文档,看着B就知道可以实现什么东西(比如这是个有关数组的排序,最大值的函数包文档),你就调用函数(B里面注释好了,对应功能在A文案的class中实现)。这样就是实现了你要做的事情。不用自己写程序,直接拿别人的来用就可以。比如你不会学实现数组排序的函数,不要紧。让老师给你个文档注释A和B(解释A功能)你就可以在你的主函数中无压力实现你要的功能了。
注意事项:
1,最好把A,B文档和你自己的主函数文档放在一个区(比如都在C盘的第一个界面),不然就有点麻烦。(反正现在我不会这个)
2,如果你存放文档的盘和控制台的盘(默认好像是C盘)不是一个盘的话。你可以把文档重新放到C 盘。或者可以使用指令改变控制台的盘(我不会写,百度上有)。
3,自己一边看一边动手比较好。比如你会觉得我写的东西很复杂,其实我觉得很清楚了。
相关文章推荐
- IIS配置WCF服务
- Xcode-5.1.1更改文件盯作者
- datagrid: 排序没有效果
- HDU 2824 The Euler function(欧拉函数)
- spring 定时任务
- sizeof求结构体大小
- 使用C语言构建基本的二叉树数据结构
- 多线程编程学习总结
- Linux————TCP/IP协议
- iOS开发系列之三 - UITextField 用法小结
- 用Spring建立RESTful Web Service的Server和Client
- tomcat配置301重定向(urlRewrite URL重写)
- ubuntu 下安装ssh服务,并修改ssh端口
- centos下 安装 rvm
- Java RMI之HelloWorld篇
- An Easy Problem?! - POJ 2826
- 如何客制化开机Logo?
- sql跨数据库批量插入
- 关于kindeditor编辑器的几个注意事项
- hdu5317 RGCDQ