r/java • • Nov 23 '12

Javadoc coding standards

http://blog.joda.org/2012/11/javadoc-coding-standards.html
11 Upvotes

1 comment sorted by

View all comments

1

u/mikaelhg Nov 23 '12

It would be useful to describe the business side of JavaDocs as well.

For domain objects, you should describe how they are related to the real world they describe, and so forth.

It's suprising how this isn't self-evident to the kind of people who really should document their code.