下面是一个使用javadoc编写文档的简单例子,里面使用了关键字@author,@version,@para,@return。其中@para后面需要紧跟方法中的参数名称,javadoc才能正确识别。
package chapter4;
/**
*
* @author duan
* @version 1.0
* 这个类用来测试javadoc
* 在这个地方编写类说明
*
*/
public class TestDoc {
/**
* name是一个字符串,内容是javadoc
*/
public static String name= "javadoc";
public TestDoc(String name){}
/**
* 这个方法改变类域中的name
* @param name 设置的名字
* @return 没有返回值
*/
public String setname(String name){
TestDoc.name = name;
return name;
}
}
下面是这个文档的页面
这样就可以提取出文档的注释了。提取的方法是选中相关的工程,点project-generate javadoc就可以一步一步生成了。