Adam Bien's Weblog
How To Comment With JavaDoc
- 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!
Special Events: Java 8 with Java EE 7: "More Power with Less Code", 13th October, 2014 and Java EE 7: "Testing and Code Quality", 14th October, 2014 Tweet Follow @AdamBien