我是否为每个实例变量编写 javadoc 注释？

Question

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

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

我收到一条错误消息，指出缺少 Javadoc 注释。[JavadocVariable]（实例变量行和 [JavadocMethod]

我是否必须编写特定的格式或语法来消除这些错误？

Answer 1

如果这样会更好的话，你可以用一行来完成。

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

Answer 2

Javadoc 注释以 开头/**和结尾*/。人们也习惯以 . 开头每行*。例如：

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