Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Package Description

 
Amit Kr Kumar
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ranchers
I am planning to provide package description for each package e.g client, server, db, common in javadoc
What should this description contain ?
How others have done it ?
Pls Guide
Amit
 
Amit Kr Kumar
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Team any suggestion please for the above query

Amit
 
Robin Underwood
Ranch Hand
Posts: 117
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You might want to explain how the classes in the package work together. A UML class diagram could show this visually.
I think the package comments are completely optional so I wouldn't worry about it.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic