如何在Eclipse中创建Java方法描述?

时间:2014-11-12 12:05:34

标签: java eclipse methods summary

我是Java和Eclipse IDE的新手。我有.NET和Visual Studio的背景知识。在VS中,当我想为方法创建描述时,我只需键入三个“/”字符,然后我会得到一个自动生成的注释模板,其外观类似于下面的示例:

/// <summary>
/// This is my summary. Hope it is helpful. ;)
/// </summary>
/// <param name="item">Description of the item parameter.</param>
/// <returns></returns>
T Add(T item); 

因此,当某人使用我的方法时,IDE会给他/她一个提示,这个提示可以直接在方法名称的顶部显示。我如何在Eclipse中实现这一点,为我的Java方法提供描述?

4 个答案:

答案 0 :(得分:7)

你应该使用/ ** * /表示法:

/** Comment */
private void method() {
}

它叫做javadoc:http://en.wikipedia.org/wiki/Javadoc

答案 1 :(得分:5)

/**
* regular
* @author John Doe
* @param 
* @return 
* @since 01-01-2000
* @version 1.0
* @exception PersonNotFoundException  gevonden
*/

答案 2 :(得分:4)

Java:只需将/**放在方法注释之前,即可生成自动。 ;)

/**
 * This is my summary. Hope it is helpful. ;)
*/
T Add(T item); 

答案 3 :(得分:0)

您可以选择一个方法,类,变量名,并在eclipse IDE中输入ALT + SHIFT + J来生成自动java描述,如下所示: -

/* (non-Javadoc)
 * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
 */
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    // TODO Auto-generated method stub
    response.getWriter().append("Served at: ").append(request.getContextPath());
}