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

javadoc style  RSS feed

 
jay mer
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
This is kind of trivial, but how do you all implement javadoc comments in your EJBs? Do you comment your business methods in the remote interface or in the bean implementation class (or both)? I've been looking in books and on the web for some code examples that include javadoc comments so that I could get some idea of what the popular style is, but I have not been able to find any examples of EJB code where javadoc comments are used...
Thanks
 
Tim Holloway
Bartender
Posts: 18662
71
Android Eclipse IDE Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I prefer both, but since I'm using a generator to create these files, there's no extra effort involved. For methods involving non-obvious processing, I might elaborate that, putting a description of the "What It Does" on the home interface, and the "How It Does It" on the bean itself. That way a client-writer gets what's needed without having a viewpoint distorted by implementations details and the implementation details are documented next to the actual implementation (where they will hopefully be kept up to date ).
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!