JavaDoc，在 Java 的注释上做文章_JAVA开发_学习笔记★闵涛★计算机学习电脑编程软硬件技巧


	转至繁体中文版	\| 网站首页 \| 图文教程 \| 资源下载 \| 站长博客 \| 图片素材 \| 武汉seo \| 武汉网站优化 \|

JavaDoc，在 Java 的注释上做文章

作者：闵涛文章来源：闵涛的学习笔记点击数：690 更新时间：2009/4/22 23:27:17

　　对于Java注释我们主要了解两种：
　　
　　// 注释一行

　　/* ...... */ 注释若干行

　　但还有第三种，文档注释：

　　/** ...... */ 注释若干行，并写入 javadoc 文档

　　通常这种注释的多行写法如下：

　　/**
　　 * .........
　　 * .........
　　 */

　　很多人多忽视了这第三种注释，那么这第三种注释有什么用？javadoc 又是什么东西？下面我们就谈谈。

　　一. Java 文档和 Javadoc

　　Java 程序员都应该知道使用 JDK 开发，最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息，具有详细的类树信息、索引信息等，并提供了许多相关类之间的关系，如继承、实现接口、引用等。

　　Java 文档全是由一些 html 文件组织起来的，在 SUM 的站点上可以下载它们的压缩包。但是你肯定想不到，这些文档我们可以自己生成。——就此打住，再吊一次胃口。

　　安装了 JDK 之后，安装目录下有一个 src.jar 文件或者 src.zip 文件，它们都是以 ZIP 格式压缩的，可以使用 WinZip 解压。解压之后，我们就可以看到分目录放的全是 .java 文件。是了，这些就是 Java 运行类的源码了，非常完整，连注释都写得一清二楚……不过，怎么看这些注释都有点似曾相识的感觉？

　　这就不奇怪了，我们的迷底也快要揭开了。如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容，你会发现它们就是一样的。Java 文档只是还在格式和排版上下了些功夫。再仔细一点，你会发现 .java 源文件中的注释还带有 HTML 标识，如＜B＞、＜BR＞、＜Code＞等，在 Java 文档中，该出现这些标识的地方，已经按标识的的定义进行了排版。

　　终于真像大白了，原来 Java 文档是来自这些注释。难怪这些注释叫做文档注释呢！不过，是什么工具把这些注释变成文档的呢？

　　是该请出 javadoc 的时候了。在 JDK 的 bin 目录下你可以找到 javadoc，如果是 Windows 下的 JDK，它的文件名为 javadoc.exe。使用 javdoc 编译 .java 源文件时，它会读出 .java 源文件中的文档注释，并按照一定的规则与 Java 源程序一起进行编译，生成文档。

　　介绍 javadoc 的编译命令之前，还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子，这里先介绍一条 javadoc 命令：

　　javadoc -d 文档存放目录 -author -version 源文件名.java

　　这条命令编译一个名为 “源文件名.java”的 java 源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两上选项可以省略。

[网页制作]JavaScript的三种消息框：警告框、确认框、提示框  [网页制作]JavaScript运算符介绍
[网页制作]JavaScript比较和逻辑运算符介绍  [网页制作]script中的language=javascript和type=text/javas…
[JAVA开发]Java连接各种数据库的实例  [办公软件]浅谈Linux 下Java 1.5 汉字方块问题解决方法
[系统软件]Regular Expression 正则表达式-2 (Java)  [C语言系列]sqlserver在JAVA中的应用
[网页制作]Dreamweaver MX实例：构建Java插入模块  [网页制作]使用Dreamweaver轻松构建Java插入模块

教程录入：mintao 责任编辑：mintao

上一篇教程：如何测定JDBC的性能

下一篇教程：用JAVA和XML构建分布式系统_

【字体：小大】【发表评论】【加入收藏】【告诉好友】【打印此文】【关闭窗口】

注：本站部分文章源于互联网，版权归原作者所有！如有侵权，请原作者与本站联系，本站将立即删除！本站文章除特别注明外均可转载，但需注明出处！ [MinTao学以致用网]

　网友评论：（只显示最新10条。评论内容只代表网友观点，与本站立场无关！）

同类栏目

· C语言系列 · VB.NET程序
· JAVA开发 · Delphi程序
· 脚本语言

热门推荐

没有教程

赞助链接

闵涛博文

500 - 内部服务器错误。

您查找的资源存在问题，因而无法显示。

鄂公网安备 42011102001154号

站长：MinTao ICP备案号：鄂ICP备11006601号-18

闵涛站盟:医药大全-武穴网。A打造B、C、D……