私有字段javadoc的自动传播到getter/setter？

Question

I've documented my bean private fields with Javadoc, explaining what each field is for. Can i propagate these documentations somehow to corrseponding getters/setters to reduce duplications of documentation? Is there's some kind of Javadoc macro for this at least?

Answer 1

You could link the javadoc comment of getters and setters to the private field by adding a javadoc link:

{@link Class#field}

However i would not really recommend this. As the previous commentators stated, i would just document the getters and setters properly. Javadoc documents your public API, which the getters and setters may belong to. Your private fields do not belong to the public API.

Answer 2

You may consider some compile-time tools like Lombok:

http://projectlombok.org/features/GetterSetter.html