File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes EJB and other Java EE Technologies and the fly likes EJBs and javadoc Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » EJB and other Java EE Technologies
Bookmark "EJBs and javadoc" Watch "EJBs and javadoc" New topic
Author

EJBs and javadoc

Jurka Rahikkala
Greenhorn

Joined: Sep 19, 2003
Posts: 2
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
Lasse Koskela
author
Sheriff

Joined: Jan 23, 2002
Posts: 11962
    
    5
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.


Author of Test Driven (2007) and Effective Unit Testing (2013) [Blog] [HowToAskQuestionsOnJavaRanch]
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: EJBs and javadoc
 
Similar Threads
NX Contractor - Sun interface no javadoc comments?
generating own depricated method
javadoc style
Importance of complete Javadoc
Write good comments and produce good javadoc