• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

package javadoc and etc

 
Ranch Hand
Posts: 175
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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?
 
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
reply
    Bookmark Topic Watch Topic
  • New Topic