Wo Dokumentation einer abstrakten Methode?

[GilbertGrape]

Hallo,

Gibt es Richtlinien wo man abstrakte Methoden dokumentiert (also mit javadoc)? In der abstrakten Klasse oder dann an der Implementierung. In den Codeconventions hab ich nichts gefunden.
Ich würde sie jetzt in die abstrakte Klasse schreiben, aber vielleicht gibts ja da irgendwelche ungeschriebenen Gesetze, vielleicht wegen der Übersichtlichkeit oder so

 

[maki]

In die abstrakte Klasse.

Die JavaDoc soll ja erklären was gemacht wird, nicht die Details wie es gemacht wird.

Man kann übrigens JavaDoc kommentare auch linken.

 

[FArt]

In die abstrakte Klasse.

Die JavaDoc soll ja erklären was gemacht wird, nicht die Details wie es gemacht wird.

Man kann übrigens JavaDoc kommentare auch linken.

.. und vererben... {@inheritdoc}

In der Regel wird man die allgemeine Beschreibung, was die Methode so treibt hier unterbringen. Der Implementierer der Methode wird sie evtl. überschreiben oder erweitern, je nach Bedarf.

 

[GilbertGrape]

Man kann übrigens JavaDoc kommentare auch linken.

Ich versteh nicht so genau was das bedeutet, aber brauch ich das in diesem Fall? Es wird doch für die überschriebene Methode automatisch das javadoc der abstrakten angezeigt (jedenfalls in Eclipse)

 

[Wildcard]

Ich versteh nicht so genau was das bedeutet, aber brauch ich das in diesem Fall? Es wird doch für die überschriebene Methode automatisch das javadoc der abstrakten angezeigt (jedenfalls in Eclipse)

Nicht wenn du an der Methode eigene Java Doc eingefügt hast.

 

[GilbertGrape]

Nicht wenn du an der Methode eigene Java Doc eingefügt hast.

ah, ok. dann versteh ich