在Java中注释代码的最佳方式是什么，有没有办法在Eclipse中自动生成函数名和参数？
例如，我正在手动编写这些 cmets：
// <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)
{
}
已经谢谢了。
【问题讨论】：
标签： java eclipse comments enterprise
看看Javadoc
Javadocs 可以很容易地在 Eclipse 中生成。你可以输入/**，它会自动完成。您还可以将代码模板配置为自动生成 javadocs。
【讨论】：
选择您想要使用 cmets 的方法并同时按 SHIFT、ALT 和 J。
花时间学习 JavaDoc，它是一个非常丰富的用于记录代码的领域。
【讨论】：
按照惯例，这是这样做的：
/** Some comments about the function
*
* @param id the user ID
* @param username The user password
*
*/
public Connect(int id, String password)
{
}
如果您的方法返回任何内容，您将添加一个 `@return' 后跟一个解释。
您的 IDE 和标准 JavaDoc 工具将能够解析它。
【讨论】：
我个人更喜欢使用JAutodoc 插件进行评论。看看它。很好。
【讨论】：
CTRL+ALT+J添加评论骨架...然后立即添加实际评论。
这个话题似乎有些混乱。我用来生成 javadoc cmets 的键序列是 SHIFT+ALT+J 而不是 CTRL?
【讨论】：
最好的方法是使用 JavaDoc，而 Eclipse 已经内置了代码模板来做到这一点。
如果您想拥有此处显示的格式，那么您可以编写自己的模板。模板功能将允许您插入变量，其中一个是方法名称。
【讨论】：
我想说，在 java 中注释代码的最佳方式是为您的方法和变量名称提供有意义的名称 :)
class MyService {
public void authenticateUser(int userId, String userPassword) {...}
}
【讨论】：
最好的方法是使用 Javadoc 注释格式，而不是您在问题中显示的那种。
在 Eclipse 中，将光标放在方法名称上，然后按 Ctrl+Alt+J。它将为您生成一个列出所有参数的 Javadoc 注释。
您还可以在Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments中控制Javadoc注释的生成方式
【讨论】：
您需要同时按下CTRL+ALT+J，同时将光标放在声明行上。
【讨论】：
我建议在 Eclipse 中使用 shift+alt+j，并写下函数的描述，以便其他开发人员可以了解该函数可以做什么，并且此自动注释功能将提供 @param 和 @return属性，以便您可以指定执行该功能所需的内容和预期的内容。
例如：
/**
* @param msg
* will return the converted message from the byte[] msg
* @return
*/
【讨论】：