Win a copy of Cross-Platform Desktop Applications: Using Node, Electron, and NW.js this week in the JavaScript forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

EJBs and javadoc  RSS feed

 
Jurka Rahikkala
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 11962
5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!