java - 自动检查 Java 代码以获取正确的约定和文档

Question

我正在评估一些学生，我正在寻找一种自动化的方法来检查 Java 约定（骆驼外壳）和文档，是否有任何工具可以做到这一点？（最好是在线工具）

Answer 1

您可以使用Checkstyle。但是，标准检查（sun 编码标准）非常严格，您可能希望从用于配置的 XML 中删除一些检查，具体取决于您的喜好

Answer 2

虽然像 Checkstyle 这样的工具可以检查对样式约定的遵守情况，但它们不应该用于评估文档。是的，checkstyle 可以检查文档是否存在，但不能检查该文档是否正确或以任何方式有用 - 无用的文档比没有更糟糕，因为它至少不会弄乱源代码。例如， checkstyle 会考虑：

/**
 * Gets the amount.
 * @return the amount
 */
BigDecimal getAmount() {
    return amount;
}


/**
 * Sets the amount.
 * @param amount the amount to set
 */
void setAmount(BigDecimal amount) {
    this.amount = amount;
}

更好（因为存在注释并且记录了所有参数和返回值），而不是

/**
 * @return the amount of this transaction (positive for deposits, negative for withdrawals)
 */
BigDecimal getAmount() {
    return amount;
}


/**
 * @see #getAmount()
 */
void setAmount(BigDecimal amount) {
    this.amount = amount;
}

因为后者没有记录方法参数...

简而言之，机器无法验证该文档是否足够，并且容易获得的指标仅显示了部分图片 - 在我看来，这在很大程度上是不相关的部分。