1

一部の開発者は、checkstyle の検出結果を渡すために、コードで JAutodoc を実行するだけで、以下に示すような無意味なコメントが生成されます。私見、自動化されたドキュメントは、名前から取得した情報に何も追加しないため、悪いです。

より良い品質のjavadocコメントを測定またはチェックするツールはありますか? 自然言語処理は期待できないと思いますが、もしかしたら他にもアイデア・ツールはあるのでしょうか...

/** The message identification. */
private String messageIdentification;

/**
 * Returns the messageIdentification.
 * 
 * @return the messageIdentification.
 */
public String getMessageIdentification() {
    return messageIdentification;
}

/**
 * Sets the messageIdentification.
 * 
 * @param messageIdentification the messageIdentification.
 */
public void setMessageIdentification(String messageIdentification) {
    this.messageIdentification = messageIdentification;
}
4

1 に答える 1

3

開発者と話をして、なぜこれを行うのかを尋ねることを検討しましたか?

一方、この getter は本当に javadoc を必要としますか? とにかくメッセージ識別とは何ですか？名前を付けた方が良いでしょうか？

 /**
 * Returns the messageIdentification.
 * 
 * @return the messageIdentification.
 */
public String getMessageIdentification() {
    return messageIdentification;
}
于 2012-01-12T12:31:10.817 に答える