Question

在Java中注释代码的最佳方法是，有没有办法在Eclipse中自动生成函数名和参数？

例如，我正在手动编写这些注释：

// <summary>
// Some comments about the function
// </summary>
// <param name="id">the user ID</param>
// <param name="username">The user password</param>
// <returns></returns>
public Connect(int id, String password)
{

}

谢谢。

Answer 1

查看Javadoc

可以在Eclipse中轻松生成Javadoc。您可以输入/**，它会自动完成。您还可以配置代码模板以自动生成javadoc。

Answer 2

选择您想要评论的方法，并同时按 SHIFT ， ALT 和 J 。

花点时间了解JavaDoc，这是一个非常丰富的区域，用于记录您的代码。

Answer 3

按照惯例，这是做到这一点的方法：

/** Some comments about the function
  * 
  * @param id the user ID
  * @param username The user password
  *
*/
public Connect(int id, String password)
{

}

如果你的方法返回任何东西，你会添加一个“@return”，后面跟一个解释。

您的IDE和标准JavaDoc工具将能够解析它。

Answer 4

我个人更喜欢使用JAutodoc插件进行评论。看看吧。很好。

Answer 5

这个帖子似乎有些混乱。我用来生成javadoc注释的关键序列是 SHIFT + ALT + J 不是 CTRL ？

Answer 6

最好的方法是使用Javadoc注释格式，而不是您在问题中显示的格式。

在Eclipse中，将光标放在方法名称上，然后按 Ctrl + Alt + J 。它将生成一个包含所有参数的Javadoc注释。

您还可以控制在Window中生成Javadoc注释的方式 - ＆gt;偏好 - ＆gt; Java - ＆gt;代码风格 - ＆gt;代码模板 - ＆gt;评论

Answer 7

最好的方法是使用JavaDoc，而eclipse内置了代码模板来实现这一目标。

如果您想拥有此处显示的格式，那么您可以编写自己的模板。模板功能允许您插入变量，其中一个变量是方法名称。

Answer 8

你需要在声明行上有光标的同时按 CTRL + ALT + J 。

Answer 9

我想说在java中注释代码的最好方法是为你的方法和变量名提供有意义的名称：）

class MyService {
    public void authenticateUser(int userId, String userPassword) {...}
}

Answer 10

我建议为Eclipse使用shift + alt + j并编写函数的描述，以便其他开发人员可以了解该函数可以执行的操作，并且此自动注释功能还将提供@param和@return属性，以便您可以指定执行功能所需的条件和预期的条件。

例如：

/**
 * @param msg
 * will return the converted message from the byte[] msg
 * @return
 */

用Java注释代码的最佳方法

10 个答案: