| |
JavaDoc，在 Java 的注释上做文章 |
|
时间: 2002-02-22 来自：yesky |
 |
|
2. 文档注释的三部分
根据在文档中显示的效果，文档注释分为三部分。先举例如下，以便说明。
第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分：
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。
有时，即使正确地以一个点号作为分隔，javadoc 仍然会出错，把点号后面的部分也做为了第一部分。为了解决这个问题，我们可以使用一个 ＜p＞ 标志将第二分部分开为下一段，如上例的“* ＜p＞show 方法的详细说明第一行 ....”。除此之外，我们也可以使用 ＜br＞ 来分隔。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。它在文档中的位置如下图所示：
这部分文档在上例中相应的代码是：
* show 方法的简述.
* ＜p＞show 方法的详细说明第一行＜br＞
* show 方法的详细说明第二行
|
发现什么了？对了，简述也在其中。这一点要记住了，不要画蛇添足——在详细说明部分中再写一次简述哦！
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置：
第三部分在上例中相应的代码是
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值 |
除了 @param 和 @return 之外，还有其它的一些特殊标记，分别用于对类、属性和方法的说明……不要推我，我马上就说。
|
|
|
|
|
|
|
|
