Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc

 
Cathy Young
Ranch Hand
Posts: 126
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Are we supposed to write package level comments? If yes, do we need it in every single class in the package?
Thanks!
Cathy
 
Valentin Crettaz
Gold Digger
Sheriff
Posts: 7610
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
package level comments would be a good idea. I don't know what others think about that...
Simply put in every package a file called package.html with a descriptive comment about the package, javadoc does the rest...
 
Cathy Young
Ranch Hand
Posts: 126
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Valentin Crettaz:

Simply put in every package a file called package.html with a descriptive comment about the package, javadoc does the rest...

Where in package? Do you mean a separate html file, maybe the same directory as other classes?
 
Pete Lyons
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes, it's a separate file called package.html and goesright next to the .java files it describes. SeeHow to Write JavaDoc Comments
 
Cathy Young
Ranch Hand
Posts: 126
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Ok, thanks, Pete!
Cathy
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic