Methode aus Superklasse dokumentieren

[deamon]

Hallo,

kann man in einer abgeleiteten Klasse eine Methode der Superklasse dokumentieren, ohne dass man die Methode wiederholt?

Beispiel:

public class Oben
{
  public void machen();
}

public class Unten extends Oben
{
  /**
   * Das verhalten von machen() ist in dieser Klasse so und so ...
   */
}

Wäre ja doof, wenn man nur zu Dokumentationszwecken eine Methode einfügen müsste, die nichts anderes tut, als den Aufruf an die Oberklasse weiterzureichen.

 

[maki]

Die Methode wird doch schon in der Superklasse dokumentiert (oder nicht), wozu die Doku nochmals wiederholen?

 

[deamon]

Weil sich das Verhalten der Methode in der Unterklasse durch andere Eigenschaften der Klasse ändert.

Ganz plattes Beispiel:

public class Oben
{
  protected String ausgabe = "A";
  public void machen()
  {
    System.out.println(ausgabe);
  }
}

public class Unten extends Oben
{
  protected String ausgabe = "b";

  /**
   * Hier sollte dokumentiert werden, dass machen() jetzt "b" ausgibt.
   */

}

 

[SlaterB]

wenn man es offiziell korrekt machen will, dann darf eine Untermethode dem Verhalten der Obermethode nicht widersprechen,
wenn Oben.machen() A ausgibt, muss Unten.machen() das mehr oder weniger genauso machen,

die Kunst wäre also eher, Oben.machen() so zu kommentieren, dass es für die Unterklasse auch gilt

----

immer klappt das sicher nicht, und zusätzliche Kommentare schaden gewiss auch nicht,
vergleiche
ArrayList.toArray(Object[] a) vs List.toArray(Object[] a) vs Collection.toArray(Object[] a) vs AbstractCollection.toArray(Object[] a)

 

[Ebenius]

Weil sich das Verhalten der Methode in der Unterklasse durch andere Eigenschaften der Klasse ändert.
[SOME CODE ...]

Das Code-Beispiel funktioniert so nicht. Man kann Methoden überschreiben, Members aber nicht.

Ebenius

 

[deamon]

Das Code-Beispiel funktioniert so nicht. Man kann Methoden überschreiben, Members aber nicht.

Ok, war vielleicht doch zu "platt" Im Prinzip ist es so, dass der Wert im Konstruktor gesetzt wird.

 

[deamon]

wenn man es offiziell korrekt machen will, dann darf eine Untermethode dem Verhalten der Obermethode nicht widersprechen,

Im Prinzip tut die Methode auch immer das Gleiche, nämlich etwas prüfen. Das Ergebnis der Prüfung hängt aber vom Zustand des Objektes ab und der wird in Unterklassen (meistens) von dem der Oberklasse abweichen.

 

[Ebenius]

Dann beschreibt man in der Super-Klasse das was die Methode in Abhängigkeit der Werte tut. Fertig.

Ebenius

 

[Wildcard]

wenn man es offiziell korrekt machen will, dann darf eine Untermethode dem Verhalten der Obermethode nicht widersprechen,

Allerdings darf man ja zB verfeinern und das sollte dann auch dokumentiert sein.
Dafür gibt es dann nützliche Dinge wie inheritDoc

 

[Ebenius]

Allerdings darf man ja zB verfeinern und das sollte dann auch dokumentiert sein.
Dafür gibt es dann nützliche Dinge wie inheritDoc

Natürlich. In diesem Kontext geht es aber leider darum, dass die darunter liegende Methode keine hinreichende bzw. zweckführende Dokumentation bietet und daher die darüberliegende Methode ausschließlich zum Zwecke der Dokumentations-Änderung überschrieben würde.

Ebenius

 

[didjitalist]

Natürlich. In diesem Kontext geht es aber leider darum, dass die darunter liegende Methode keine hinreichende bzw. zweckführende Dokumentation bietet und daher die darüberliegende Methode ausschließlich zum Zwecke der Dokumentations-Änderung überschrieben würde.

Ebenius

wenn der kommentar dieser methode an der oberklasse für die unterklasse nicht zutrifft, dann sollte man sie überschreiben. auch wenn man lediglich die methode der oberklasse aufruft und sonst nichts macht.

es ist allerdings fragwürdig, warum die oberklasse überhaupt falsch dokumentiert ist.

 

[deamon]

Die Oberklasse ist nicht falsch dokumentiert, es wäre nur schön, die Auswirkungen der Spezialisierung auf diese Methode in Unterklassen dokumentieren zu können. Im Moment tue ich das auf Klassenebene.