在Eclipse中生成API方法

在Eclipse中生成API方法

百度文库

http://wenku.baidu.com/view/bef8e60c79563c1ec5da714c.html

 

（1）在代码里用javadoc注释

package  com.sdccip.action;
import  com.opensymphony.xwork2.ActionSupport;
import  com.sdccip.pojo.User;
import com.sdccip.service.impl.UserService;
/**
* 职员action类
* @author shinebar
* @versio 157
* @description职员的action处理类
*/
// @Controller("clerkAction")
public class ClerkAction extends ActionSupport {
// private IClerkService clerkService;
/**
* 职员action类中的add()方法
* @return  String
* @param 无
*/
private static final long serialVersionUID = 1L;
public  String add() {
return null;
}
}

（2）Eclispe中生成注释方式

方法有三： 

1.选择工程，在菜单Project->Genarate Javadoc 
2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮 
3.选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮 
然后，可以选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步 。 

   此时如果项目采用的是 UTF － 8 的编码 ，一定要在这一页的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 〃 。否则生成的网页中文注释都是乱码。 点 Finish 完成, 

在工程的doc 目录中，就有Javadoc 文档了。