Javadoc对班级成员的评论

Question

我有很多类成员变量。它们中的每一个都很重要，理想情况下需要一个解释它是什么的评论。如果我尝试向每个元素添加元素注释，它最终会看起来像：

/**
 * 
 */
private int[] violationCounterRise = new int[Consts.NUMBER_OF_PMU];
/**
 * 
 */
private String eSeverity;
/**
 * 
 */

等等......这使得代码非常混乱且难以理解。有没有其他方法可以添加javadoc注释以避免在这种特定情况下出现笨拙？

Answer 1

不，没有。但是，插入空行实际上可能帮助可读性。

/**
 * 
 */
private int[] violationCounterRise = new int[Consts.NUMBER_OF_PMU];

/**
 * 
 */
private String eSeverity;

另外，请考虑仅在启用-private选项时才会生成私有字段的JavaDoc。由于私有字段仅在查看源代码时才起作用，因此您可能不需要首先生成它们，在这种情况下// - 样式注释也可以起作用。

最后，想一想为什么你有这么多成员变量。可能是您的班级违反单一责任原则并需要重构。