eclipse是在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和eclipse内置的代码模板来实现这一点

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

Answer 2

看看Javadoc

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

Answer 3

这条线索似乎有些混乱。我用来生成javadoc注释的关键序列是SHIFT+ALT+JnotCTRL

Answer 4

按照惯例，这是一种方法：

/** 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 5

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

Answer 6

选择需要评论的方法，然后同时按SHIFT键、ALT键和J键

花点时间了解一下JavaDoc，这是一个非常丰富的代码文档领域