欢迎来到天天文库
浏览记录
ID:12712945
大小:130.00 KB
页数:14页
时间:2018-07-18
《javadoc注释使用方法》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、JavaDOC注释使用方法目录前言一.Java文档和javadoc二.文档注释的格式1.文档注释的格式化2.文档注释的三部分三.使用javadoc标记1.@see的使用2.使用@author、@version说明类3.使用@param、@return和@exception说明方法四.javadoc命令前言Java的语法与C++及为相似,那么,你知道Java的注释有几种吗?是两种?//注释一行/....../注释若干行不完全对,除了以上两种之外,还有第三种,文档注释:/....../注释若干行,并写入javadoc文档通常这种注释的多
2、行写法如下:/................../一.Java文档和javadocJava程序员都应该知道使用JDK开发,最好的帮助信息就来自SUN发布的Java文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、实现接口、引用等。Java文档全是由一些html文件组织起来的,在SUM的站点上可以下载它们的压缩包。但是你肯定想不到,这些文档我们可以自己生成。安装了JDK之后,安装目录下有一个src.jar文件或者src.zip文件,它们都是以ZIP格式压缩的,
3、可以使用WinZip解压。解压之后,我们就可以看到分目录放的全是.java文件。是了,这些就是Java运行类的源码了,非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉?这就不奇怪了,我们的迷底也快要揭开了。如果你仔细对比一下.java源文件中的文档注释(/.../)和Java文档的内容,你会发现它们就是一样的。Java文档只是还在格式和排版上下了些功夫。再仔细一点,你会发现.java源文件中的注释还带有HTML标识,如、、等,在Java文档中,该出现这些标识的地方,已经按标识的的定
等,在Java文档中,该出现这些标识的地方,已经按标识的的定
4、义进行了排版。终于真像大白了,原来Java文档是来自这些注释。难怪这些注释叫做文档注释呢!不过,是什么工具把这些注释变成文档的呢?是该请出javadoc的时候了。在JDK的bin目录下你可以找到javadoc,如果是Windows下的JDK,它的文件名为javadoc.exe。使用javdoc编译.java源文件时,它会读出.java源文件中的文档注释,并按照一定的规则与Java源程序一起进行编译,生成文档。介绍javadoc的编译命令之前,还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子,这里先介绍一条javad
5、oc命令:javadoc-d文档存放目录-author-version源文件名.java这条命令编译一个名为“源文件名.java”的java源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中index.html就是文档的首页。-author和-version两个选项可以省略。二.文档注释的格式文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用/..../限定之外,还需要注意注释内部的一些细节问题。1.文档和文档注释的格式化生成的文档是HTML格式,而这些HTML格式的标识符并不是javadoc加
6、的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入,如果要分段,就应该在段前写入
。因此,格式化文档,就是在文档注释中添加相应的HTML标识。文档注释的正文并不是直接复制到输出文件(文档的HTML文件),而是读取每一行后,删掉前导的号及号以前的空格,再输入到文档的。如 /Thisisfirstline.Thisissecondline.Thisisthirdline./编译输出后的HTML源码则是 Thisisfirstline.Thisissecondline.<
7、br>Thisisthirdline.前导的号允许连续使用多个,其效果和使用一个号一样,但多个号前不能有其它字符分隔,否则分隔符及后面的号都将作为文档的内容。号在这里是作为左边界使用,如上例的第一行和第二行;如果没有前导的号,则边界从第一个有效字符开始,而不包括前面的空格,如上例第三行。还有一点需要说明,文档注释只说明紧接其后的类、属性或者方法。如下例: /commentforclass/publicclassTest{/commentforaattribute/intnumber;/commentforamethod/public
8、voidmyMethod(){......}......}上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要,如果忽略了这一点,就很可能造成生成的文档错误。如
此文档下载收益归作者所有