java_javadoc

文档注释标记为/**            */

文档注释直接被写入程序中，可以被提取出来

javadoc标记如下

@author 确定类的作者
@deprecated 指示反对使用这个类或成员
{@docRoot} 指定当前文档的根目录路径(Java2的1.3版新增)
@exception 确定一个方法引发的异常
{@link} 插入对另一个主题的内部链接
@param 为方法的参数提供文档
@return 为方法的返回值提供文档
@see 指定对另一个主题的链接
@serial 为默认的可序列化字段提供文档
@serialData 为writeObject()或者writeExternal()方法编写的数据提供文档
@serialField 为ObjectStreamField组件提供文档
@since 当引入一个特定改变时,声明发布版本
@throws 与@exception相同
@version 指定类的版本

/**
*Title: PersonJavaDoc<br>
*Description: 通过 PersonJavaDoc 类来说明 Java 中的文档注释<br>
*Copyright:(c) 2004 www.sun.com.cn<br>
*Company : sun java </br>
*@author lixinghua
*@version 1.00
*/
public class PersonJavaDoc
{
private String name = "Careers";
private String sex = "male";
private int age = 30;
/**
*这是 PersonJavaDoc 对象无参数的构造方法
第
204
页
*/
public PersonJavaDoc()
{ }
/**
*这是 PersonJavaDoc 类的有参构造方法
*@param name PersonJavaDoc 的名字
*@param sex PersonJavaDoc 的性别
*@param age PersonJavaDoc 的年龄
*/
public PersonJavaDoc(String name,String sex,int age)
{
this.name = name ;
this.sex = sex;
this.age = age;
}
/**
*这是设置 name 的值的方法,将参数 name 的值赋给变量 this.name
*@param name PersonJavaDoc 的名字
*/
public void setName(String name)
{
this.name = name;
}
/**
*这是取得 name 的值的方法
*@返回 name 的值
*/
public String getName()
{
return name;
}
/**
*这是取得 age 的值的方法
*@返回 age 的值
*/
public int getAge()
{
第
205
页
return age;
}
/**
*这是设置 sex 的值的方法,将参数 sex 的值赋给变量 this.sex
*@param sex PersonJavaDoc 的性别
*/
public void setSex(String sex)
{
this.sex = sex ;
}
/**
*这是取得 sex 的值的方法
*@返回 sex 的值
*/
public String getSex()
{
return sex;
}
/**
*这是设置 age 的值的方法
*@param age PersonJavaDoc 的年龄
*/
public void setAge(int age)
{
if(age<0)
this.age = 0;
else
this.age = age;
}
public void shout()
{
System.out.println("我是 "+name+",
我性别 "+sex+",
今年 "+age+" 岁!
");
}
}