是否为每个实例变量编写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

Javadoc注释以/**开头，以*/结尾。按照惯例，每个新行都以*开始。例如：

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

Answer 2

如果可以做得更好，您可以在一行中完成。

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