手机端小强原创文章,java小强个人博客站点
当前位置: 首页 >> 理论 >> JDK工具-javadoc命令

JDK工具-javadoc命令

24490 理论 | 2015-7-31

Javadoc是Oracle公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档。

 

项目-->右键菜单Export-->Java下Javadoc-->next:
javadoc command:就是要调用的javadoc.exe,不用修改,eclipse会找到的;
use standard doclet:就是要生成到的目录,自定义一个文件夹作为存放目录[不然一大堆];
默认即可next-->再next-->
【注意注意】此时如果项目采用的是UTF-8编码,Extra Javadoc options下需要输入设定参数,否则生成的网页中文注释都是乱码。

-encoding utf-8 -charset utf-8

最后Finish完成。


在工程的doc 目录中,就有Javadoc 文档了

一般注释解释:

@author 作者名   
@version 版本标识   
@parameter 参数及其意义 
@since 最早使用该方法/类/接口的JDK版本   
@return 返回值 
@throws 异常类及抛出条件 
@deprecated 引起不推荐使用的警告   
@see reference 
@override 重写

 

参考接口和类:

package test;
/**
 * 测试接口
 * @author java小强
 * @version 0.0.1
 */
public interface TestFace {
}

类:

package test;
/**
 * 测试文档输出<b>大写测试</b><br>
 * 已经换行<br>
 * Class <code>JavaBlogTest</code> is by java小强
 * 
 * @author java小强
 * @version 0.0.1
 * @since 1.5
 */
public class JavaBlogTest implements TestFace{
 /** 拼接到参数后返回 */
 private String BACK = "_BACK";
 /**
  * 获得新生
  * @param oldStr 老参数
  * @return 返回参数
  * @exception IndexOutOfBoundsException if <code>oldStr</code> is null
  */
 public String getStr(String oldStr){
  return oldStr + BACK;
 }
}


操作步骤和生成结果截图:


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令


JDK工具-javadoc命令

推荐您阅读更多有关于“ jdk javadoc 文档 since ”的文章

上一篇:JDK工具-javap命令 下一篇:JDK工具-native2ascii命令

猜你喜欢

发表评论:

个人资料
blogger

java小强
没有思考,人生的路会越走越难!

搜索
分类
最新微语
  • 今日北京再次沙尘暴来袭,吃了几年细粮,终于能来口粗粮了,不过大早上看见这场景,还是吓我一跳,不过随后就平静了,毕竟是老朋友了。进公司又发现一股烤糊的味道,真是祸不单行啊,例外都是污染。发了两个口罩,开启保护模式。

    2017-05-04 10:16

  • 今天同学问我,最近还在写代码吗?我想了想,这个问题怎么回答呢,我好像确实很长时间,虽然写了一些,但是主要内容已经不是写代码了。然后再想想,自己也7年多了,这么多年了,我收获了什么,我的目标到底是什么。眼看就奔三了,人生啊,开启感叹模式。

    2017-03-30 22:52

  • 也许大家都已经注意到了,今年的房价,好多地方都是翻了一番,跟着就是,各地房东开始变相涨租。今年之所以搬走,就是为此,这两天同学也是如此。很多房东只认钱,别谈感情,伤钱。而对于这个城市来说,你怎么定位自己,你真把自己当成她的一份子?你来此为何?将来何去何从?自己掂量清楚。

    2016-12-05 10:03

  • 为什么一直不写了呢?因为当爸爸了,没空了。今年的冬天,有些寒冷,除了这寒冬带来的不适,更有因乐视公司遇到危机,而带来的同事别离。送别同事,看着空旷的工位,心中有些悲凉。临近年关,此时此刻,该怎么做,似乎不再是脑子一热那么简单了。

    2016-11-24 11:28

  • 已经请假,加上国庆,要很长一段时间不在北京了。919加班,搞的现在有点心累,胸闷,身体不适。看来,我要好好休息一下了。这几天有些冷,2016的冬天,一步步来了,各位亲友,记得添衣加粗啊。

    2016-09-23 17:29

  • 更多»

最新文章
热门文章
随机文章