Java - Konvention für die Verwendung von Javadoc zusammen mit einer Methode Annotation?

Question

Ich habe die folgende Methode:

@Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Wenn ich ein javadoc für diese Methode hinzufügen mag, gibt es eine Konvention, wie dies zu tun, zusammen mit der @Override Anmerkung (oder andere Anmerkung)?

Der Grund, den ich frage, ist, weil ich gelesen habe, dass javadoc Kommentare MUSS direkt vor der Methode sein sollten (keine Zeilenumbrüche zwischen den beiden), und ich bin mir nicht sicher, ob der javadoc Kommentar direkt über der @Override Anmerkung verwirren würde Dinge auf.

Wäre dies der herkömmliche Weg, es zum Beispiel zu tun? Funktioniert das?

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Answer 1

Ja, dieser Weg ist der richtige Weg, ich habe noch nicht anders herum gesehen. Und ja, so funktioniert es. Ich habe es nicht umgekehrt versucht.

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Aber grundsätzlich würde ich in der Regel nicht ein javadoc Kommentar ein Verfahren hinzufügen, die eine andere Methode überschreibt, vor allem, wenn Schnittstellen implementieren. Das Tag @inheritDoc ist hier hilfreich, um die Dokumentation ohne großen Aufwand zu verteilen. Aber das ist spezifisch für dieses Beispiel. Sie könnten auch andere Anmerkungen hinzufügen.

Answer 2

Ja, es wird korrekt funktionieren. Zum Beispiel verwenden sie in der source code of java.lang.String von openjdk Javadoc über die @Deprecated Annotation.