关于Java的注释[Java编程]

关于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 两上选项可以省略.

　　以上是“关于Java的注释[Java编程]”的内容，如果你对以上该文章内容感兴趣，你可以看看七道奇为您推荐以下文章：