注释和嵌入式文档

概述

javadoc 只能为public 和protected的成员进行文档注释，private(可以使用-private标记)和包内访问成员的注释会被忽略； 注释文档用在类、方法、字段前。

---

一、语法

javadoc命令只能始于"/**"，结束于"*/"

---

二、方式

• 文档标签
• 嵌入式HTML

---

2.1 独立文档标签

以 @开头的命令

下面的@param ，就放在最开头

  @param   proxy the proxy instance that the method was invoked on

---

2.2 行内文档标签

以 @ 开头，包括在 { } 内; 可以出现在javadoc注释中的任何地方。

像下面的{@code Method}

 * @param   method the {@code Method} instance corresponding to
 * the interface method invoked on the proxy instance.  The declaring
 * class of the {@code Method} object will be the interface that
 * the method was declared in, which may be a superinterface of the
 * proxy interface that the proxy class inherits the method through.

---

2.3 嵌入HTML

像下面的 ol 和 li

/**
*
*

*
 Item one
*
 Item two
*
*/

注：不要在嵌入式HTML使用标题标签。例如

；因为javadoc会插入自己的标签。

---

三、其他

在java SE5中，Javadoc标签@deprecated已经被@Deprecated注解所替代

---

参考

[1]. 《java编程思想》– 第二章