• 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 all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Liutauras Vilda
  • Campbell Ritchie
  • Tim Cooke
  • Bear Bibeault
  • Devaka Cooray
Sheriffs:
  • Jeanne Boyarsky
  • Knute Snortum
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Ganesh Patekar
  • Stephan van Hulst
  • Pete Letkeman
  • Carey Brown
Bartenders:
  • Tim Holloway
  • Ron McLeod
  • Vijitha Kumara

@serial tag in Javadoc  RSS feed

 
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
 
ranger
Sheriff
Posts: 17314
11
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
 
author and jackaroo
Marshal Commander
Posts: 12218
279
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: 17314
11
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
Posts: 12218
279
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!