方法評論和注釋......每個應該去哪里？

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的語言。 通常情況下，它放在同一條線上（盡管你會看到很多不是這樣的例子）。