Granny's Programming Pearls
"inside of every large program is a small program struggling to get out"
JavaRanch.com/granny.jsp
Win a copy of Functional Reactive Programming this week in the Other Languages forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

JavaDoc package and class description

 
K. Tsang
Bartender
Posts: 3521
16
Android Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello, I'm finishing up my assignment and want to ask about the javadoc for the package and class level.

How much description is needed for a package and class? Currently I use a one-liner describing the purpose of the package or class. Is it necessary to expand this by say including how this class is used in my application etc?

Thanks.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic