方法评论和注释......每个应该去哪里？

Question

所以， 假设我有一个包含如此注释的方法：

@Override
public void bar(String x)

如果我要在这段代码中添加Javadoc注释，这是首选方法？

或者：

/**
* @param x A string lol
*/
@Override
public void bar(String x)

或

@Override
/**
* @param x A string lol
*/
public void bar(String x)

Answer 1

第一个。注释适用于方法，而不适用于注释。这也是大多数IDE都会做的事情，无论如何也是如此。

Answer 2

就个人而言，我更喜欢前者（即注释“触及”方法签名），因为那时它是带代码的代码。

但要么适用于编译器，那么这取决于个人品味/您组织的编码标准。

Answer 3

意见：第一种方法更可取。在某种程度上，注释和方法比注释更强大。

Answer 4

通常，注释在方法之前的行（或行）上是凹坑。注释可能有点长，可以放在同一行。

然而，@Override有点特别。它有效地弥补了没有override的语言。通常情况下，它放在同一条线上（尽管你会看到很多例子，但不是这样）。