Java 文档注释标签的使用方法

javadoc可以根据源代码中的注释生成相应的文档,但注释必须符合指定的格式.
java的文档注释以/**开头,*/结束,可以注释类名,字段,方法,如:


/**
 * 学生类
 * @author fff
 *
 */
public class Student {
	/**
	 * 学号
	 */
	int id;
	/**
	 * 姓名
	 */
	String name;
	/**
	 * 年龄
	 */
	int age;
	
	/**
	 * 打印学生信息
	 */
	public void print()
	{
		System.out.println("id:"+id+" name:"+name+" age:"+age);
	}
}

除了可以利用这些信息生成文档,在Eclipse中,当在其他地方用到这个类时,鼠标移动到方法名上,也会弹出注释内容提示(效果与设置javadoc路径一样).
另上,还可以使用一些标签丰富注释内容,如上面的@author 标记该类的作者
下面是几个常用标签:
@see 类名#方法或字段名 添加一个See Also(参见),点击点跳到指定类或类下的字段,方法的注释说明,如果目标类不在同一个包下或没有import包,必须使用包括包名的完整路径,如果是参见当前类的方法或字段,可以不加类名
{@link 类名#方法或字段名 别名} 功能与@see一样,但可以指定链接显示的名称
{@docRoot} 显示文档根目录路径
{@inheritDoc} 复制父类的相关注释到此
@since 运行环境 通常用于标识最低版本的运行环境 如jdk 1.6,API Level 4等等
@param 参数名 说明 各个参数的说明,多个参数使用多个@param标签
@return 返回值说明 添加返回值的说明
@throws 异常类名 异常说明 指定可能出现的异常,并提供异常说明,多个异常用多个@throws标签
@deprecated 标记该类或方法字段已经被废弃,不建议使用,在新版本中可能删除,如果使用,编译器会警告,Eclipse里会加上删除线,但在Eclipse里好像会跟其他的注释冲突,有了这个标签,其他的就不会提示了.

© 2013, 冰冻鱼. 请尊重作者劳动成果,复制转载保留本站链接! 应用开发笔记

发表评论

电子邮件地址不会被公开。 必填项已用*标注