Hi List, Our current coding guideline [1] does not contain guidelines for the way we should use Javadoc. After a short discussion, Ivo and I decided that we should _not_ use tags like @inheritDoc or @see if their _only_ goal is to point to the interface method we implement or the base method we override; both your IDE and the Javadoc tool can handle these links fine.
A thing we don't quite agree on is using Javadoc that 'doesn't say anything', e.g. "gets the name" on a getName() method. If this is in a public API interface, the javadoc should be improved, but as long as we have not improved it yet, we could remove it, so we don't create the impression that this is the final doc. What does the list think on this one? Angelo [1] http://amdatu.org/confluence/display/Amdatu/Java+Coding+Style+Guide -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.amdatu.org/pipermail/amdatu-developers/attachments/20101019/83942005/attachment.html
