メソッドのコメントと注釈...それぞれはどこに行くべきですか?
このコードスニペットにJavadocのコメントを追加するのが好ましい方法ですか?
/**
* @param x A string lol
*/
@Override
public void bar(String x)
または
@Override
/**
* @param x A string lol
*/
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)
まず1。アノテーションはメソッドに適用され、コメントには適用されません。それはまた、ほとんどのIDEがやることだから、とにかく最も一般的です。
個人的には、前者(つまり、メソッドシグネチャに「注釈を付ける」注釈)が好きです。それはコード付きのコードなので、
しかしどちらもコンパイラで動作しますので、個人的な好み/組織のコーディング標準になります。
意見:最初の方法が好ましい。ある意味では、アノテーションとメソッドはコメントよりも強く属しています。
一般に、アノテーションはメソッドの直前の行(または行)のピットです。同じ行に注釈を付けるには、少し長くすることができます。
ただし、@Override
は少し特殊です。それは効果的にoverride
を持っていない言語を補うものです。従来は、同じ行に配置されています(しかし、そうではない例がたくさんあります)。
ありがとうございました - これは役に立ちます:) 通常、人々は怠け者であり、コメントを追加しない理由を探しますが、この種の混乱は時には理由です。それを支持するための1つの方法があることは素晴らしいことです。 – Bohdan