企业门户网站建站,网站文章来源seo,总裁班课程培训,wordpress 左图右文对于Java注释我们主要了解三种#xff1a;// 注释一行/* ...... */ 注释若干行第三种#xff0c;文档注释#xff1a;/** ...... */ 注释若干行#xff0c;并写入 javadoc 文档通常这种注释的多行写法如下#xff1a;/*** .........* .........*/很多人多忽视了这第三种注…对于Java注释我们主要了解三种// 注释一行/* ...... */ 注释若干行第三种文档注释/** ...... */ 注释若干行并写入 javadoc 文档通常这种注释的多行写法如下/*** .........* .........*/很多人多忽视了这第三种注释那么这第三种注释有什么用javadoc 又是什么东西下面我们就谈谈。一. Java 文档和 JavadocJava 程序员都应该知道使用 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 两上选项可以省略。二. 文档注释的格式文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用 /** .... */ 限定之外还需要注意注释内部的一些细节问题。1. 文档和文档注释的格式化生成的文档是 HTML 格式而这些 HTML 格式的标识符并不是 javadoc 加的而是我们在写注释的时候写上去的。比如需要换行时不是敲入一个回车符而是写入 br如果要分段就应该在段前写入 p。因此格式化文档就是在文档注释中添加相应的 HTML 标识。文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)而是读取每一行后删掉前导的 * 号及 * 号以前的空格再输入到文档的。如/*** This is first line. br***** This is second line. brThis is third line.*/编译输出后的 HTML 源码则是This is first line. brThis is second line. brThis is third line.前导的 * 号允许连续使用多个其效果和使用一个 * 号一样但多个 * 号前不能有其它字符分隔否则分隔符及后面的 * 号都将作为文档的内容。* 号在这里是作为左边界使用如上例的第一行和第二行如果没有前导的 * 号则边界从第一个有效字符开始而不包括前面的空格如上例第三行。还有一点需要说明文档注释只说明紧接其后的类、属性或者方法。如下例/** comment for class */public class Test {/** comment for a attribute */int number;/** comment for a method */public void myMethod() { ...... }......}上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要如果忽略了这一点就很可能造成生成的文档错误。如import java.lang.*;/** commnet for class */public class Test { ...... }// 此例为正确的例子这个文档注释将生成正确的文档。但只需要改变其中两行的位置变成下例就会出错/** commnet for class */import java.lang.*;public class Test { ...... }// 此例为错误的例子这个例子只把上例的 import 语句和文档注释部分交换了位置结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在“/** commnet for class */”是对 class Test 的说明把它放在“public class Test { ...... }”之前时其后紧接着 class Test符合规则所以生成的文档正确。但是把它和“importjava.lang.*;”调换了位置后其后紧接的就是不 class Test 了而是一个 import 语句。由于文档注释只能说明类、属性和方法import 语句不在此列所以这个文档注释就被当作错误说明省略掉了。2. 文档注释的三部分根据在文档中显示的效果文档注释分为三部分。先举例如下以便说明。/*** show 方法的简述.* pshow 方法的详细说明第一行br* show 方法的详细说明第二行* param b true 表示显示false 表示隐藏* return 没有返回值*/public void show(boolean b) {frame.show(b);}第一部分是简述。文档中对于属性和方法都是先有一个列表然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分简述部分写在一段文档注释的最前面第一个点号 (.) 之前 (包括点号)。换句话说就是用第一个点号分隔文档注释之前是简述之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。有时即使正确地以一个点号作为分隔javadoc 仍然会出错把点号后面的部分也做为了第一部分。为了解决这个问题我们可以使用一个 p 标志将第二分部分开为下一段如上例的“* pshow 方法的详细说明第一行 ....”。除此之外我们也可以使用 br 来分隔。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明在格式上没有什么特殊的要求可以包含若干个点号。它在文档中的位置如下图所示这部分文档在上例中相应的代码是* show 方法的简述.* pshow 方法的详细说明第一行br* show 方法的详细说明第二行发现什么了对了简述也在其中。这一点要记住了不要画蛇添足——在详细说明部分中再写一次简述哦第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置第三部分在上例中相应的代码是* param b true 表示显示false 表示隐藏* return 没有返回值除了 param 和 return 之外还有其它的一些特殊标记分别用于对类、属性和方法的说明……不要推我我马上就说。三. 使用 javadoc 标记javadoc 标记是插入文档注释中的特殊标记它们用于标识代码中的特殊引用。javadoc 标记由“”及其后所跟的标记类型和专用注释引用组成。记住了三个部分——、标记类型、专用注释引用。不过我宁愿把它分成两部分 和标记类型、专用注释引用。虽然 和 标记类型之间有时可以用空格符分隔但是我宁愿始终将它们紧挨着写以减少出错机会。javadoc 标记有如下一些标记 用于 作用author 对类的说明 标明开发该类模块的作者version 对类的说明 标明该类模块的版本see 对类、属性、方法的说明 参考转向也就是相关主题param 对方法的说明 对方法中某参数的说明return 对方法的说明 对方法返回值的说明exception 对方法的说明 对方法可能抛出的异常进行说明下面详细说明各标记。1. see 的使用—对应于java JDK API中的“另请参见”如下图see 的句法有三种see 类名see #方法名或属性名--//标记方法或属性时“#”符号必须有see 类名#方法名或属性名类名可以根据需要只写出类名 (如 String) 或者写出类全名 (如 java.lang.String)。那么什么时候只需要写出类名什么时候需要写出类全名呢如果 java 源文件中的 import 语句包含了的类可以只写出类名如果没有包含则需要写出类全名。java.lang 也已经默认被包含了。这和 javac 编译 java 源文件时的规定一样所以可以简单的用 javac 编译来判断源程序中 javac 能找到的类javadoc 也一定能找到javac 找不到的类javadoc 也找不到这就需要使用类全名了。方法名或者属性名如果是属性名则只需要写出属性名即可如果是方法名则需要写出方法名以及参数类型没有参数的方法需要写出一对括号。如成员类型 成员名称及参数 see 句法属性 number see number属性 count see count方法 count() see count()方法 show(boolean b) see show(boolean)方法 main(String[] args) see main(String[])有时也可以偷懒假如上例中没有 count 这一属性那么参考方法 count() 就可以简写成 see count。不过为了安全起见还是写全 see count() 比较好。see 的第二个句法和第三个句法都是转向方法或者属性的参考它们有什么区别呢第二个句法中没有指出类名则默认为当前类。所以它定义的参考都转向本类中的属性或者方法。而第三个句法中指出了类名则还可以转向其它类的属性或者方法。关于 see 标记我们举个例说明。由于 see 在对类说明、对属性说明、对方法说明时用法都一样所以这里只以对类说明为例。/*** see String* see java.lang.StringBuffer* see #str* see #str()* see #main(String[])* see Object#toString()*/public class TestJavaDoc {}生成的文档的相关部分如下图String 和 StringBuffer 都是在 java.lang 包中由于这个包是默认导入了的所以这两个类可以直接写类名也可以写类全名。str、str() 为同名属性和方法所以方法名需要用 () 区分。main 是带参数的方法所以在 () 中指明了参数类型。toString() 虽然在本类中也有 (从 Object 继承的)但我们是想参考 Object 类的 toString() 方法所以使用了 Object#toString()。奇怪的是为什么其中只有 str、str() 和 main(String[]) 变成了链接呢那是因为编译时没有把 java.lang 包或者 Stirng、StringBuffer、Object 三个类的源文件一起加入编译所以生成的文档没有关于那三个类的信息也就不可以建立链接了。后面讲解 javadoc 编译命令的时候还会详细说明。上例中如果去把类中的 str 属性去掉那么生成的文档又会有什么变化呢你会发现原来是 str, str()而现在变成了 str(), str()因为 str 属性已经没有了所以 str 也表示方法 str()。2. 使用 author、version 说明类这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略但命令行开关 -author 和 -version 可以修改这个功能使其包含的信息被输出。这两个标记的句法如下author 作者名version 版本号其中author 可以多次使用以指明多个作者生成的文档中每个作者之间使用逗号 (,) 隔开。version 也可以使用多次只有第一次有效生成的文档中只会显示第一次使用 version 指明的版本号。如下例/*** author Fancy* author Bird* version Version 1.00* version Version 2.00*/public class TestJavaDoc {}生成文档的相关部分如图从生成文档的图示中可以看出两个 author 语句都被编译在文档中生成了作者列表。而两个 version 语句中只有第一句被编译了只生成了一个版本号。从图上看作者列表是以逗号分隔的如果我想分行显示怎么办另外如果我想显示两个以上的版本号又该怎么办——我们可以将上述两条 author 语句合为一句把两个 version 语句也合为一句author FancybrBirdversion Version 1.00brVersion 2.00结果如图我们这样做即达到了目的又没有破坏规则。author 之后的作者名和 version 之后的版本号都可以是用户自己定义的任何 HTML 格式所以我们可以使用 br 标记将其分行显示。同时在一个 version 中指明两个用 br 分隔的版本号也没有破坏只显示第一个 version 内容的规则。3. 使用 param、return 和 exception 说明方法这三个标记都是只用于方法的。param 描述方法的参数return 描述方法的返回值exception 描述方法可能抛出的异常。它们的句法如下param 参数名 参数说明return 返回值说明exception 异常类名 说明每一个 param 只能描述方法的一个参数所以如果方法需要多个参数就需要多次使用 param 来描述。一个方法中只能用一个 return如果文档说明中列了多个 return则 javadoc 编译时会发出警告且只有第一个 return 在生成的文档中有效。方法可能抛出的异常应当用 exception 描述。由于一个方法可能抛出多个异常所以可以有多个 exception。每个 exception 后面应有简述的异常类名说明中应指出抛出异常的原因。需要注意的是异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。 示例如下public class TestJavaDoc {/*** param n a switch* param b excrescent parameter* return true or false* return excrescent return* exception java.lang.Exception throw when switch is 1* exception NullPointerException throw when parameter n is null*/public boolean fun(Integer n) throws Exception {switch (n.intValue()) {case 0:break;case 1:throw new Exception(Test Only);default:return false;}return true;}}使用 javadoc 编译生成的文档相关部分如下图可以看到上例中 param b excrescent parameter 一句是多余的因为参数只是一个 n并没有一个 b 但是 javadoc 编译时并没有检查。因此写文档注释时一定要正确匹配参数表与方法中正式参数表的项目。如果方法参数表中的参数是 a文档中却给出对参数 x 的解释或者再多出一个参数 i就会让人摸不着头脑了。exception 也是一样。上例程序中并没有抛出一个 NullPointerException但是文档注释中为什么要写上这么一句呢难道又是为了演示这不是为了演示描述多余的异常也能通过编译而是为了说明写异常说明时应考运行时 (RunTime) 异常的可能性。上例程序中如果参数 n 是给的一个空值 (null)那么程序会在运行的时候抛出一个 NullPointerException因此在文档注释中添加了对 NullPointerException的说明。上例中的 return 语句有两个但是根据规则同一个方法中只有第一个 return 有效其余的会被 javadoc 忽略。所以生成的文档中没有出现第二个 return 的描述。讲到这里该怎么写文档注释你应该已经清楚了下面就开始讲解 javadoc 的常用命令。四. javadoc 命令运行 javadoc -help 可以看到 javadoc 的用法这里列举常用参数如下用法javadoc [options] [packagenames] [sourcefiles]选项-public 仅显示 public 类和成员-protected 显示 protected/public 类和成员 (缺省)-package 显示 package/protected/public 类和成员-private 显示所有类和成员-d directory 输出文件的目标目录-version 包含 version 段-author 包含 author 段-splitindex 将索引分为每个字母对应一个文件-windowtitle text 文档的浏览器窗口标题javadoc 编译文档时可以给定包列表也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下fancy.Editorfancy.Testfancy.editor.ECommandfancy.editor.EDocumentfancy.editor.EView这里有两个包 (fancy 和 fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令javadoc fancy/Test.java fancy/Editor.java fancy/editor/ECommand.java fancy/editor/EDocument.java fancy/editor/EView.java这是给出 java 源文件作为编译参数的方法注意命令中指出的是文件路径应该根据实际情况改变。也可以是给出包名作为编译参数如javadoc fancy fancy.editor用浏览器打开生成文档的 index.html 文件即可发现两种方式编译结果的不同如下图用第二条命令生成的文档被框架分成了三部分包列表、类列表和类说明。在包列表中选择了某个包之后类列表中就会列出该包中的所有类在类列表中选择了某个类之后类说明部分就会显示出该类的详细文档。而用第一条命令生成的文档只有两部分类列表和类说明没有包列表。这就是两种方式生成文档的最大区别了。两种方式编译还有一点不同下面再来细说选项。-public、-protected、-package、-private 四个选项只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系如下表-private (显示所有类和成员)-package (显示 package/protected/public 类和成员)-protected (显示 protected/public 类和成员)-public (仅显示 public 类和成员)-d 选项允许你定义输出目录。如果不用 -d 定义输出目录生成的文档文件会放在当前目录下。-d 选项的用法是-d 目录名目录名为必填项也就是说如果你使用了 -d 参数就一定要为它指定一个目录。这个目录必须已经存在了如果还不存在请在运行 javadoc 之前创建该目录。-version 和 -author 用于控制生成文档时是否生成 version 和 author 指定的内容。不加这两个参数的情况下生成的文档中不包含版本和作者信息。-splitindex 选项将索引分为每个字母对应一个文件。默认情况下索引文件只有一个且该文件中包含所有索引内容。当然生成文档内容不多的时候这样做非常合适但是如果文档内容非常多的时候这个索引文件将包含非常多的内容显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类每个字母对应一个文件。这样就减轻了一个索引文件的负担。-windowtitle 选项为文档指定一个标题该标题会显示在窗口的标题栏上。如果不指定该标题而默认的文档标题为“生成的文档(无标题)”。该选项的用法是-windowtitle 标题标题是一串没有包含空格的文本因为空格符是用于分隔各参数的所以不能包含空格。同 -d 类似如果指定了 -windowtitle 选项则必须指定标题文本。到此为止Java 文档和 javadoc 就介绍完了。javadoc 真的能让我们在 Java 注释上做文章——生成开发文自己积累1.不能在返回类型为void的方法中使用return标记2.在无参的函数前不需要写param标记如果写了则“无参数。”会被认为是参数名。作者tj_shenzhendaxue 发表于2013-5-4 16:11:11 原文链接阅读62 评论0 查看评论
