@inheritDocs

[kwonilchang]

Hallo!

Habe folgendes Problem bei Erstellung von JavaDoc:

Ich habe eine Interfaceklasse mit Kommentaren vorgegeben und dieses in einer weiteren Klasse implementiert. Hierfür möchte ich nun JavaDocs erstellen. Bei Methoden, die noch nicht im Interface vorhanden waren, macht das auch keine Probleme. Aber ich bin mir nicht sicher, wie ich das mit denen machen soll, die schon im Interface standen.

Habe gehört, dass man in solchen Fällen mit einem @inheritDocs arbeiten kann. Leider finde ich hierzu keine passende Erklärung.

Kann mir da jemand weiterhelfen, wie ich das einsetze und wie dann der Kommentar genau aussehen soll?

Danke schonmal!

 

[eRaaaa]

es heißt @inheritDoc

    /**
     * {@inheritDoc}
     */
    @Override
    public void foo() {
	
    }