2013-04-01 7 views
7

Uso il progetto Lombok ma getter e setter non hanno JavaDoc.Uso il progetto Lombok ma getter e setter non hanno JavaDoc

Come posso attivare questa opzione?

+2

Il punto di avere JavaDoc su questi metodi è che possono spiegare come il campo viene in genere utilizzato o il collegamento ai campi correlati. Sebbene nella maggior parte dei casi il nome dovrebbe essere abbastanza descrittivo, ho letto la mia parte di codice in cui uno scopo del campo non era ovvio, o dove un setter modifica un altro comportamento. Inoltre, è un posto per annotare la legalità dei valori nulli. –

risposta

7

Esiste un'implementazione iniziatica nella versione 0.12.0. Di default l'intero contenuto del javadoc sul campo sarà copiato sia nel getter che nel setter. Getters otterrà il bit di ritorno; imposta il bit param. Quelli saranno rimossi dal javadoc sul campo. Usando le sezioni puoi anche specificare diversi getter/setter javadoc.

Questo funziona solo quando si delombok il codice prima di generare javadoc e probabilmente non funzionerà mai in eclissi.

Per la sintassi corrente, consultare la documentazione di feature request s.

Full Disclosure: sono uno degli sviluppatori di Project Lombok.

+0

Un'altra domanda: come posso creare tranquillamente i setter definibili da un costruttore con Lombok? – Stephan