用Eclipse生成javadoc文件

先来说说什么是javadoc文档

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

说白了,学java编程的基本都用过API吧,javadoc相当于那个,以网页的形式显示出来。 😯

用于注释

/**被注释语句*/   专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。

关键词列表

@author 作者名

@version 版本标识

@parameter 参数及其意义

@since 最早使用该方法/类/接口的JDK版本

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@see reference

使用方法

  1. 在项目列表中右键单击你要导出的文件,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。
  2. javadoc command:应该选择jdk的bin/javadoc.exe
  3. destination:为生成文档的保存路径,可自由选择。
  4. 按finish(完成)提交即可开始生成文档。
  5. 找到你的生成的文件夹下,打开index.html就可以看到了。

javadoc

>> 若为原创,转载请注明: 转载自Laycher's Blog

>> 本文链接地址: 用Eclipse生成javadoc文件

>> 订阅本站: http://feed.feedsky.com/laycher



无觅相关文章插件,快速提升流量

《用Eclipse生成javadoc文件》有4个想法

发表评论

电子邮件地址不会被公开。 必填项已用*标注