javadoc

twZiJevN

关键字: java、

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

一. Java 文档和  

简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。

有时，即使正确地以一个点号作为分隔， 仍然会出错，把点号后面的部分也做为了第一部分。为了解决这个问题，我们可以使用一个 ＜p＞ 标志将第二分部分开为下一段，如上例的“* ＜p＞show 方法的详细说明第一行 ....”。除此之外，我们也可以使用 ＜br＞ 来分隔。


第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。它在文档中的位置如下图所示：








这部分文档在上例中相应的代码是：





* show 方法的简述.
* ＜p＞show 方法的详细说明第一行＜br＞
* show 方法的详细说明第二行

发现什么了？对了，简述也在其中。这一点要记住了，不要画蛇添足——在详细说明部分中再写一次简述哦！

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置：








第三部分在上例中相应的代码是





* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
除了 @param 和 @return 之外，还有其它的一些特殊标记，分别用于对类、属性和方法的说明……不要推我，我马上就说。

三. 使用  标记

标记是插入文档注释中的特殊标记，它们用于标识代码中的特殊引用。 标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了，三个部分——@、标记类型、专用注释引用。不过我宁愿把它分成两部分：@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔，但是我宁愿始终将它们紧挨着写，以减少出错机会。

标记有如下一些：





标记
用于
作用

@author
对类的说明
标明开发该类模块的作者

@version
对类的说明
标明该类模块的版本

@see
对类、属性、方法的说明