Eclipse Javadoc an Methode mit @override

[Skrodde]

Hallo zusammen,
ich habe eine Klasse in Eclipse, welche ein Interface implementiert. So weit, so gut. Nun stehen da also Funktionen wie

@Override
public Boolean isLinearFunction() {
	return false;
}

Nun möchte ich für diese Funktion ein JavaDoc anlegen. Eigentlich kein Problem, ich gehe in die Zeile über dem Funktionsaufruf, schreibe /**, bestätige mit Enter und bekomme mein JavaDoc Feld. Das klappt in dieser Klasse auch mit allen Funktionen, die KEIN @override davor haben. Bei den Funktionen mit @Override klappt allerdings gar nichts. Weder über dem @Override mein /** einzutippen, noch das @Override zu löschen und dann /** zu tippen. In jedem Fall bekomme ich einfach nur ein recht leeres Javadoc

/**
*
*/

selbst, wenn die Methode etwas zurück gibt oder Parameter hat.
Kann mir jemand sagen woran das liegt und wie ich mein Javadoc für diese Methoden schreiben kann (möglichst ohne alles per Hand zu machen)?
Vielen Dank, Gruß, Skrodde

 

[SlaterB]

> Weder über dem @Override mein /** einzutippen, noch das @Override zu löschen und dann /** zu tippen. In jedem Fall bekomme ich einfach nur ein recht leeres Javadoc

wenn @Override offensichtlich nichts damit zu tun hast, wieso erwähnst du das dann so oft?
sprich doch einfach nur von 'überschreibenden Methoden' oder so

-------


hier ist das normalerweise eingestellt,
schaue dir die Konfiguration zum JavaDoc von normalen Methoden an,
wenn du generell nicht unterscheiden willst

 

[nillehammer]

Wenn Du eine Methode aus einem Interface/einer Superklasse implementierst, ist davon auszugehen, dass in diesem Interface/Superklasse die Dokumentation der Parameter/Return-Werte bereits erledigt ist. Auch wenn es im Quellcode nicht sichtbar ist, werden die Java-Docs richtig generiert. Prüfen kannst Du das in Eclipse mit der javadoc-View bzw. durch Drüberfahren mit der Maus über die entspr. Methode. Nur, wenn die Implementierung irgendwelche Spezialitäten hat, macht es Sinn, dies extra zu dokumentieren, DANN macht man es per Hand. Mal an Deinem Beispiel:

public interface Function {

  /**
     * @return true, if this function is linear, false othwerwise
     **/
  public Boolean isLinearFunction();
}

public class DefaultFunctionImpl implements Function {

   private final Boolean linear;

   public DefaultFunctionImpl(final Boolean linear) {
      this.linear = linear;
   }

// Hier macht erneutes Dokumentieren eigentlich keinen Sinn,
// Es ist alles im Interface dokumentiert.
// Aber je nach Codestyle-Conventions meckert z.B. Checkstyle, 
// wenn der javadoc-Kommentar fehlt, deswegen mache ich immer
// das hier:
   /**
      *@{inheritdoc}
      **/
   @Override
   public Boolean isLinearFunction() {
      return this.linear
   }
}

public class NonLinearFunctionImpl implements Function {
...
// Hier macht ein erneutes Dokumentieren von return Sinn,
// Da hier Spezialverhalten dokumentiert wird
   /**
      * @return always Boolean.FALSE, this implementation is non-linear
      */
   @Override
   public Boolean isLinearFunction() {
      return Boolean.FALSE;
   }
}

 

[Skrodde]

Danke für den Tipp. Ich habe jetzt bei mir an entsprechender Stelle nachgesehen und da stehet:

/* (non-Javadoc)
 * ${see_to_overridden}
 */

Sollte er dann nicht zumindest dies einfügen, statt das Feld quasi leer zu lassen?

 

[SlaterB]

das funktioniert bei mir, wenn man /* eintippt und dann Enter,

für /** + Enter sollte es wohl auch eine ensprechende Konfiguration mit /** am Anfang sein

 

[Skrodde]

Oh ... *Hand vor den Kopf hau* stimmt, da steht ja nur ein Sternchen. So lassen sich schwierige Probleme schnell lösen. Ich mach wohl erst mal eine Pause, offensichtlich sehe ich die Sternchen vor Sternchen schon nicht mehr.

Vielen Dank für die Hilfe! :toll:

 

[nillehammer]

Sollte er dann nicht zumindest dies einfügen, statt das Feld quasi leer zu lassen?

Ist Geschmackssache. Wie gesagt, eigentlich sind (Javadoc-)Kommentare nur sinnvoll, wenn sie auch etwas interessantes aussagen. Redundante nonsense-Kommentare blähen den Code nur auf. Deshalb ist die Defaulteinstellung in Eclipse ist eine andere. Wenn aber eine Codierrichtlinie das vorschreibt, muss man halt in den sauren Apfel beißen. Dann kann man die Einstellung seinen eigenten Wünschen anpassen unter

Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Overriding Methods

Da kannst Du auch den Haken setzen bei

Automatically add comments ...

. Dann macht Eclipse es immer.

 

[SlaterB]

@nillehammer
wieso tippst du
> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Overriding Methods
mühsam ein, hab doch schon ein Bild gepostet

 

[nillehammer]

@nillehammer
wieso tippst du
> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Overriding Methods
mühsam ein, hab doch schon ein Bild gepostet

Ups, nicht gesehen...