Aenigma / ActionMockup

Other
1 stars 0 forks source link

Javadoc Should Not Containing Implementation Details #11

Open Aenigma opened 10 years ago

Aenigma commented 10 years ago

Comments are great. Javadocs are comments but not necessarily all comments are javadoc worthy.

Do not do things like make excuses for implementations and such for all public members. Perhaps move "personal" comments into non-javadoc comment blocks within the method block.

This task isn't high priority right now, though; just something that should be done between now and the final product. Over time, we should be listing out these kinds of comments and listing it here.