• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

package javadoc and etc

 
Mike Yu
Ranch Hand
Posts: 175
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Do I need package level javadoc comments for Fligh By Night?
Should all the classes use the same version and date?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mike,
Do I need package level javadoc comments for Fligh By Night?

I think you should. It provides the high level overview of what the purpose of each package is for, which can really help the examiner (and it is more professional).
Should all the classes use the same version and date?

I don't think so. The version numbers and dates are meant to reflect the changes to the classes. Hopefully auto generated when you check them into your revision control system. Setting them all to the same version number could mean that you are throwing out all your old revisions and standardising on your current revision. But this goes against the whole point of having revisions.
I was just looking at the source code for WeakHashMap - my copy is release 1.19 but this is just an internal number. You wont see that in the javadoc. It is just something that someone looking at the code can see, and can therefore determine whether they have the latest version or not.
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic