メソッドのコメントと注釈...それぞれはどこに行くべきですか？

Question

このコードスニペットに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

まず1。アノテーションはメソッドに適用され、コメントには適用されません。それはまた、ほとんどのIDEがやることだから、とにかく最も一般的です。

Answer 2

個人的には、前者（つまり、メソッドシグネチャに「注釈を付ける」注釈）が好きです。それはコード付きのコードなので、

しかしどちらもコンパイラで動作しますので、個人的な好み/組織のコーディング標準になります。

Answer 3

意見：最初の方法が好ましい。ある意味では、アノテーションとメソッドはコメントよりも強く属しています。

Answer 4

一般に、アノテーションはメソッドの直前の行（または行）のピットです。同じ行に注釈を付けるには、少し長くすることができます。

ただし、@Overrideは少し特殊です。それは効果的にoverrideを持っていない言語を補うものです。従来は、同じ行に配置されています（しかし、そうではない例がたくさんあります）。