# How To Comment With JavaDoc

Put

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!