java - 最初に注釈またはブロック コメント? （コメントスタイル）

Question

/* Prints the coordinate */
@Override
public String toString() {
    return new StringBuilder("(").append(x).append(",").append(y).append(",").append(z).append(")").toString();
}

上記の例では、メソッドのコメントが最初に来ました。これは通常行われていることですか、それとも逆のことが受け入れられていることですか?

Answer 1

それは完全に選択の問題であり、チームのコーディング規約によって決定されると言われていますが、個人的には、次の方法の方がはるかに優れていて表現力に優れていると感じています。

/**
  comments
  .... 
*/
@Annotation
type method(){
    ...
    ...
 }