Codestyle; javadoc vor oder nach der Annotation einfügen?

148

Ich weiß, dass es nicht das wichtigste Problem ist, aber ich habe gerade festgestellt, dass ich den Javadoc-Kommentarblock vor oder nach der Anmerkung einfügen kann. Was würden wir als Kodierungsstandard annehmen?Codestyle; javadoc vor oder nach der Annotation einfügen?

/** 
* This is a javadoc comment before the annotation 
*/ 
@Component 
public class MyClass { 

    @Autowired 
    /** 
    * This is a javadoc comment after the annotation 
    */ 
    private MyOtherClass other; 
}

Quelle

2010-06-24 Paul McKenzie

158

Vor der Annotation, da die Annotation Code ist, der der Klasse "gehört". Siehe examples with javadoc in der offiziellen Dokumentation.

Hier willkürliches Beispiel I in another official Java page gefunden:

/** 
* Delete multiple items from the list. 
* 
* @deprecated Not for public use. 
* This method is expected to be retained only as a package 
* private method. Replaced by 
* {@link #remove(int)} and {@link #removeAll()} 
*/ 
@Deprecated public synchronized void delItems(int start, int end) { 
    ... 
}

Quelle

2010-06-24 12:37:00

Auch hier von Interesse - die Annotation ist in der gleichen Zeile wie die anderen Qualifier für die Methode. Ich habe das noch nie zuvor gesehen, aber es scheint darauf hinzuweisen, dass Annotationen ähnlich wie andere Qualifier für eine Methode behandelt werden sollten, und daher sollte das Javadoc definitiv davor stehen. – ArtOfWarfare

Das Einfügen der gleichen Anmerkungen in dieselbe Zeile kann schnell außer Kontrolle geraten, wenn Sie eine Anmerkung wie Jackson verwenden. Ich setze jede Anmerkung auf eine eigene Zeile. –

Es kommt alles auf Lesbarkeit des. Meiner Meinung nach ist Code mit den Anmerkungen direkt über der Methode/dem Feld lesbarer.

Quelle

2010-06-24 12:38:22

Ich stimme den bereits gegebenen Antworten zu.

Anmerkungen sind Bestandteil des Code während javadoc Teil der Dokumentation (daher der Name) ist.

Also für mich scheint es vernünftig, die Code-Teile zusammen zu halten.

Quelle

2010-06-24 13:05:01 perdian

Abgesehen von der Kodierung Standard, es scheint, dass Javadoc-Tool nicht verarbeitet die Java Doc Kommentare, wenn sie nach den Anmerkungen platziert werden. Funktioniert ansonsten gut.

Quelle

2013-10-25 08:49:37 shadrik

Codestyle; javadoc vor oder nach der Annotation einfügen?

Antwort

Verwandte Themen