Methoden Kommentare und Anmerkungen ... wohin sollen sie gehen?

9

Also, Nehmen wir an, ich habe eine Methode, die eine Annotation wie folgt enthält:

%Vor%

Wenn ich diesem Code-Snippet Javadoc-Kommentare hinzufügen würde, was ist die bevorzugte Methode?

Entweder:

%Vor%

Oder:

%Vor%     
Polaris878 07.12.2010, 17:28
quelle

4 Antworten

15

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

    
OrangeDog 07.12.2010, 17:30
quelle
2

Persönlich bevorzuge ich die erstere (d. h. Anmerkung, die Methodensignatur "berührend"), da es dann Code mit Code ist.

Aber entweder funktioniert das für den Compiler, also liegt es am persönlichen Geschmack / an den Kodierungsstandards Ihrer Organisation.

    
Andrzej Doyle 07.12.2010 17:31
quelle
2

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

    
Vincent Ramdhanie 07.12.2010 17:31
quelle
1

Im Allgemeinen werden Anmerkungen in der Zeile (oder den Zeilen) direkt vor der Methode angezeigt. Anmerkungen können ein bisschen lang sein, um in die gleiche Zeile zu setzen.

Allerdings ist @Override etwas Besonderes. Es gleicht effektiv die Sprache aus, die nicht override hat. Konventionell wird es auf dieselbe Zeile gesetzt (obwohl Sie viele Beispiele sehen werden, wo es nicht ist).

    
Tom Hawtin - tackline 07.12.2010 23:25
quelle

Tags und Links