Methodenkommentare und Anmerkungen ... wohin soll jeder gehen?

Question

So läßt sagen, dass ich eine Methode, die eine Anmerkung wie so enthält:

@Override 
public void bar(String x) 

Wenn ich Javadoc Kommentare zu diesem Code-Snippet hinzuzufügen war, die die bevorzugte Methode ist?

Entweder:

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

Oder:

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

Answer 1

erste. Die Anmerkung gilt für die Methode, nicht für den Kommentar. Es ist auch, was die meisten IDEs tun werden, also ist es das üblichste überhaupt.

Answer 2

Persönlich bevorzuge ich die ehemalige (d. H. Annotation "berühren" die Methodensignatur), seitdem ist es Code mit Code.

Aber entweder funktioniert für den Compiler, also ist es auf persönlichen Geschmack/die Kodierungsstandards Ihres Unternehmens.

Answer 3

Meinung: Die erste Methode ist vorzuziehen. In gewisser Weise gehören die Annotation und die Methode zusammen stärker als der Kommentar.

Answer 4

Im Allgemeinen werden Anmerkungen in der Zeile (oder den Zeilen) direkt vor der Methode angezeigt. Anmerkungen können ein wenig lang sein, um in dieselbe Zeile zu passen.

Allerdings ist @Override ein bisschen speziell. Es gleicht effektiv die Sprache aus, die override nicht hat. Herkömmlicherweise wird es auf dieselbe Zeile gesetzt (obwohl Sie viele Beispiele sehen werden, wo es nicht ist).