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!
NEW workshop: Java EE 7 Testing, Deployment, Automation and Code Quality: January 28th, 2015, Airport Munich