How To Comment With JavaDoc

Put

  1. the WHAT in the name
  2. the HOW in the code, and
  3. 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…

<<Adam Bien>>

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s