This week's book giveaway is in the OO, Patterns, UML and Refactoring forum. We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line! See this thread for details.
Hi, Is there any general rules or guidelines how to add javadoc comments to EJBs? Should I add comments to remote interface or bean? How should I add references to actual comments? And what's the situation when I'm using e.g. DAO pattern, so that I have more layers to document? I'd really appreciate, if someone could point out the right place for javadoc API documentation. Cheers, Jurka
Hi Jurka, and welcome to the JavaRanch! I would suggest the following practice: Write "business level" documentation into business interfaces (remote, local) and "implementation detail" documentation into the implementation class javadocs. Another option could be to write the javadocs only into the business interface and refer to it from the implementation class' javadocs with a @see tag.