Wie kann eine Methode Javadoc kopiert werden in andere Methode ist Javadoc?

Ich weiß, dass es @inheritDoc, aber es ist nur für Methoden, die andere überschreiben.

Ich habe mehrere Klassen mit vielen delegieren Methoden (die nicht andere überschreiben).

Können Ihre Javadoc-sein "geerbt" (genauer: kopiert)?

/** here I need the copy of wrappedMethod's Javadoc */
public void delegateMethod(Object param){
  innerSomething.wrappedMethod(param);
}
InformationsquelleAutor java.is.for.desktop | 2010-09-01
  1. 13

    Einen @ - link oder @siehe-tag wäre hier angebracht. Wenn Sie das einwickeln der Methode, es muss unverwechselbares Verhalten, das macht Sie ungeeignet für eine überlastung oder sonst.

    • Ja, aber @link oder @see sind leider nicht hilfreich, wenn die wrapped-Methode ist geschützt 🙁
    • es sei denn, Sie generieren von javadocs für protected-Methoden auch...
    • @seanizer Oh, ich wusste gar nicht, dass es möglich ist, danke!
    • Dies funktioniert nicht für Methoden, die eine geringere Sichtbarkeit als das, was generiert wird. Für die Bibliothek Schriftsteller, es ist nicht eine option zum erzeugen von JavaDoc mit privaten Mitgliedern zum Beispiel. Ich würde gerne wissen, einen Weg zu Wiederverwendung privat-Dokumentation in der öffentlichen API.
    InformationsquelleAutor Danny Thomas
  2. 9

    Manchmal ist es eigentlich eine gute Sache, um Ausschneiden und einfügen-Dokumentation. 'Verknüpfung' Dokumentation in irgendeiner Weise, vor allem, wenn es nicht an der Vererbung Beziehung, läuft das Risiko, dass eine der Methoden wird Verhalten irgendwie verändert, so dass die verlinkten Dokumentation nicht mehr gültig.

    Jedoch im Fall von Delegierten habe ich das gleiche problem hatte eine Anzahl von Zeiten. In der Regel haben Sie eine öffentliche Methode, die auf einer main-Klasse zu delegieren, um eine package-private delegieren, die hat genau das gleiche Verhalten wie der main-Methode. Hier die Lösung ist einfach - Dokument die main-Klasse, und legen Sie die @ - link oder @finden Sie auf der delegate-Klasse. Jeder kann sehen, wie die main-class " - Dokumentation. Sie werden wahrscheinlich brauchen, um mehr detaillierte Dokumentation, wie die Umsetzung details, auf die der delegate-Klasse zu.

    InformationsquelleAutor DJClayworth
Schreibe einen Kommentar