Do I write javadoc comments for each instance variable?

Viewed 6634
private String label = "";
private String color = "";
private double edge = 0;

public Dodecahedron(String labelIn, String colorIn, double edgeIn)

I am getting an error message stating missing Javadoc comment. [JavadocVariable] (the instance variable lines and [JavadocMethod]

Is there a specific format or syntax I have to write to get rid of these errors?

2 Answers

You can do it in a single line if that makes it better.

/** The session that will be used. */
private CastSession session;

Javadoc comments start with /** and end with */. It's also customary to start each new line with a *. E.g.:

/**
 * The label to use.
 */
private String label = "";
Related