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

後者はメソッドパラメーターを文書化していないため...

要するに、ドキュメントが適切であることは機械で検証できず、簡単に取得できるメトリックは全体像の一部しか示していません。これは私の意見ではほとんど関係のない部分です。