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;
}

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

简而言之，该文档已经足够无法通过机器进行验证，并且易于获取的指标仅显示部分图片 - 在我看来这是一个很大程度上不相关的部分。

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

2 个答案: