java注释文档

阅读数:25 评论数:0

跳转到新版页面

python/Java

所有javadoc命令都只能出现于“/**”注释中，位于每一行开头的星号和前导空格都会被javadoc丢弃。

1、javadoc的两种使用方式

（1）嵌入的HTML

（2）文档标记（@开头的命令）

2、三种类型的注释文档

/** 一个类注释 */
public class docTest {
/** 一个变量注释 */
public int i;
/** 一个方法注释 */
public void f() {}
}

注意javadoc只能为public（公共）和protected（受保护）成员处理注释文档。

我们可以在注释中使用html标签来格式化注释文档。

不要使用html的标题标签，因为javadoc会插入自己的标题，这样会发生冲突。

所有注释的文档（类、变量、方法），都支持html

@see	@see 引用其他类 @see 类名 @see 完整类名 @see 完整类名#方法名
@param	@param 参数名说明	方法的参数
@return	@return 说明	不能出现的构造方法中
@exception	@exception 完成类名说明	可能抛出的异常说明，一般用于方法注释
@deprecated	@deprecated 说明	指名一个过期的类或成员，表示该类或方法不建议使用
@version	@version 版本信息
@author	@author 作者信息
@since	@since 说明	标明从哪个版本起开始有这个
{@link}	{link name text}	到另一处的链接