Details des Unterschieds zwischen @see und @inheritDoc

Ich habe mir über JavaDoc-Referenz, und während ich verstehen grundlegende Unterschied zwischen @see (diverse links) und {@inheritDoc} (export von Oberklasse JavaDoc-Kommentar), ich brauche eine Klärung, wie die Dinge tatsächlich umgesetzt werden.

In der Eclipse-IDE, wenn ich die Option "Generate Element "Kommentare" für die geerbte Methode (von der Schnittstelle, oder toString() überschreiben und so weiter) entsteht folgenden Kommentar

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

Wenn ich benötigt, um zu produzieren JavaDoc sollte ich es dabei belassen, ersetzen @see mit {@inheritDoc} oder schalten Sie es in bona-fide - JavaDoc als solche:

/**
 * {@inheritDoc}
 */

Und wenn ich das mache, soll ich noch halten die Klasse#Methode-flag?

InformationsquelleAutor der Frage theUg | 2012-11-11

  1. 97

    Zunächst, Sie sollten entfernen Sie die original-eclipse-template, da ist es nur laut junk. Entweder man aussagekräftige Dokumente, die in oder setzen Sie nicht alles auf alle. Aber nutzlos Neuformulierung des offensichtlichen, mit dem IDE-Vorlagen überfrachtet den code.

    Zweitens, wenn Sie erforderlich sind, zu produzieren, javadoc, dann haben zu dem Kommentar start mit /**. Ansonsten ist es kein javadoc.

    Schließlich, wenn Sie überschreiben dann sollten Sie @inheritDoc (vorausgesetzt, Sie wollen hinzufügen, um die original-docs, da @seh bemerkte in einem Kommentar, wenn Sie nur wollen, duplizieren Sie die original-docs, dann brauchen Sie nicht alles). @see sollte eigentlich nur verwendet werden, um Referenz anderen Verwandte Methoden.

    InformationsquelleAutor der Antwort jtahlborn

Schreibe einen Kommentar