How do I use the @serialField javadoc tag?

Created Apr 21, 2000

Tim Rohaly

If you declare your serialiazable fields using the serialPersistentFields member (see FAQ http://www.jguru.com/jguru/faq/view.jsp?EID=1197) then you should document these fields using the @serialField javadoc tag. The syntax of this tag is:

    @serialField  field-name  field-type  field-description

The serialPeristentFields member is an array of ObjectStreamField objects, declared as follow:

    private static final ObjectStreamField[] serialPeristentFields;

You should have one @serialField tag for each element of the serialPersistentFields array. These tags should appear in the javadoc comment preceding the declaration of serialPersistentFields.

In the standard javadoc output, this information is displayed only in the "Serialized Form" page for that class.