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

@serial tag in Javadoc

 
Samantha O'Neill
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everyone
I have added the @serial Javadoc tag to my doc comments for all fields in the FieldInfo and DataInfo classes as these are declared as Serializable. Do I have to add this tag to all other classea s well? When I turn on the -serialwarn option when running Javadoc it gives me a warning for all fields not just those in Serializable implementing classes. I really don't want to go back and add all these if its not necessary.
I would be interested to know how others have handled this.
Many thanks Sam
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I didn't use it anywhere, even for my DataInfo or FieldInfo classes. I got 100% on the JavaDocs.
Mark
 
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
I didn't use it anywhere, even for my DataInfo or FieldInfo classes. I got 100% on the JavaDocs.
Also.
Regards, Andrew
 
Samantha O'Neill
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
That was the answer I was hoping for - thanks for your replies. Much appreciated!
Thanks Sam
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Andrew Monkhouse:
I didn't use it anywhere, even for my DataInfo or FieldInfo classes. I got 100% on the JavaDocs.
Also.
Regards, Andrew


Copycat.
Mark
 
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
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic