javadoc 只能为public 和protected的成员进行文档注释,private(可以使用-private标记)和包内访问成员的注释会被忽略; 注释文档用在类、方法、字段前。
javadoc命令只能始于"/**",结束于"*/" - 文档标签
- 嵌入式HTML
以 @开头的命令
下面的
@param,就放在最开头
@param proxy the proxy instance that the method was invoked on 以 @ 开头,包括在 { } 内; 可以出现在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. 像下面的
ol和li
/** * *<ol> *<li> Item one *<li> Item two *</ol> */ ע:不要在嵌入式HTML使用标题标签。例如<h1>;因为javadoc会插入自己的标签。
在java SE5中,Javadoc标签@deprecated已经被@Deprecated注解所替代
文章来源: 注释和嵌入式文档