Eclipse用法和技巧四：生成说明文档1

最新推荐文章于 2019-07-07 10:01:30 发布

最新推荐文章于 2019-07-07 10:01:30 发布 · 225 阅读

文章标签：

#开发工具 #java

本文介绍如何使用JavaDoc注释方法在Eclipse环境下生成程序开发文档，包括添加注释的方法、原理及应用实例，以及JavaDoc工具如何抽取类、方法、成员注释并形成API帮助文档。

写代码经常要添加注释的，java代码的注释也可以分为两种。单行注释以“//”作为开头就可以。段落注释在第一行开头添加“/*”，在最后一行结尾添加“*/"即可。这里介绍一种添加注释的方法，其注释的数据域和方法，能在Eclipse环境下，在调用处显示出来。上图：

步骤一：在要添加说明的方法上一行输入"/**"

步骤二：回车

步骤三：查看效果

补充说明下：这种添加注释的方法专门为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。JavaDoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过JavaDoc就可以同时形成程序的开发文档了。
怎么通过JavaDoc形成程序的开发文档就是接下来要介绍的。

上一篇文章，Eclipse用法和技巧三：自动生成Main方法2：
http://blog.youkuaiyun.com/ts1122/article/details/8769426

下一篇文章，Eclipse用法和技巧五：生成说明文档2 ：
http://blog.youkuaiyun.com/ts1122/article/details/8798127