7
Ich benutze Lombok Projekt, aber Getter und Setter haben keine JavaDoc.Ich benutze Lombok Projekt, aber Getter und Setter haben keine JavaDoc
Wie kann ich diese Option aktivieren?
A
Antwort
7
Es gibt eine initiale Implementierung in der Version 0.12.0. Standardmäßig wird der gesamte Inhalt des Javadocs auf dem Feld sowohl auf den Getter als auch auf den Setter kopiert. Getters erhalten das Rückgabe-Bit; setzt das param-Bit. Diese werden aus dem Javadoc auf dem Spielfeld entfernt. Mit Hilfe von Abschnitten können Sie sogar verschiedene Getter/Setter-Javadocs angeben.
Dies funktioniert nur, wenn Sie den Code vor dem Generieren von Javadoc delombok, und wird wahrscheinlich nie in Eclipse arbeiten.
Die aktuelle Syntax finden Sie in der Dokumentation feature request.
Vollständige Offenlegung: Ich bin einer der Entwickler Project Lombok.
+0
Eine weitere Frage: Wie kann ich endgültige Setter erstellen, die von einem Konstruktor mit Lombok sicher aufgerufen werden können? – Stephan
Der Punkt, an dem JavaDoc für diese Methoden verwendet wird, ist, dass sie erklären können, wie das Feld normalerweise verwendet wird, oder mit verwandten Feldern verknüpfen. Obwohl der Name in den meisten Fällen beschreibend genug sein sollte, habe ich meinen Code-Anteil gelesen, bei dem der Zweck des Feldes nicht offensichtlich war oder wo ein Setter anderes Verhalten ändert. Es ist auch ein Ort, um die Legalität von Null-Werten zu kommentieren. –