• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

NX: A question concerning JavaDoc

 
Ulrich Heeger
Ranch Hand
Posts: 266
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everyone,
I have a question concerning the JavaDoc.
After the class description, I add the @author and @version tag:

I don't know if it's correct concerning the version-tag. I have specified this version due to the specs of my assigment, "Application Submission(Version 1.2.3)". Or should I perhaps add

Comments?
Thanks in advance
Ulrich
 
George Marinkovich
Ranch Hand
Posts: 619
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ulrich,
Originally posted by Ulrich Heeger:

I don't know if it's correct concerning the version-tag. I have specified this version due to the specs of my assigment, "Application Submission(Version 1.2.3)".

I think it's a good idea to have a version tag. No one's going to question what you put for your version tag, so you can put whatever is meaningful to you. I put the version of the software I was developing (version 1.0) and the date the file was last modified. It doesn't really matter.
 
Nicholas Cheung
Ranch Hand
Posts: 4982
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ulrich,
In general, the @version tag refers to the version number of that piece of code. Thus, it maybe inappropiate for putting the version of which assignment you are doing.
Maybe when you write the code at the very beginning, the version is 1.0. When you submit the code, together with the whole assignment, the version is 2.6. Thus, it should have no relationship between your assignment version number and the code version.
Nick.
 
Ulrich Heeger
Ranch Hand
Posts: 266
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Georges, hi Nick,
thanks a lot for your help.
I think I will put @version 1.0, because it's my first "release" of this software. Sounds resonnable?
Greetings
Ulrich
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic