Java 中注释代码的最佳方式

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

Javadoc 可以在 Eclipse 中轻松生成。您可以输入 /** 它会自动完成。您还可以配置代码模板以自动生成 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 已经内置了代码模板来实现这一点。

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

Answer 7

我想说，在 java 中注释代码的最佳方法是为您的方法和变量名称提供有意义的名称:)

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

Answer 8

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

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

您还可以在Window -> 中控制Javadoc注释的生成方式。首选项-> Java->代码风格->代码模板 ->评论

Answer 9

您需要在将光标置于声明行时同时按 CTRL+ALT+J。

Answer 10

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

例如：

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