- the WHAT in the name
- the HOW in the code, and
- the WHY in the comment
Sometimes there is no WHY. The reason and intentions are more than obvious (getters / setters, toString, equals methods etc.).
Writing JavaDoc for the obvious cases should be considered as defect...
Thanks Kai Windmöller for the suggestion / comment!
See you at Java EE Workshops at MUC Airport, particularly at: Effective Java EE 7!
NEW online workshop: WebStandards Igniter (online)
Airport MUC workshops: Java EE 8, Java 9: Bootstrap, Effective, Architectures, Single Page Apps, Progressive Web Apps, HTML 5, ES 6, CSS 3 and Microservices
Podcast: airhacks.fm and newsletter: airhacks.news
A book about rethinking Java EE Patterns