2012-01-12 6 views
1

checkstyleの結果を渡すために、以下のようにナンセンスのコメントを生成するコードでJAutodocを実行する開発者もいます。私は名前から得た情報に何も追加しないので、自動化されたドキュメントは悪いです。JAutodocとCheckstyle:品質の高いjavadocを測定またはチェックするツールを知っていますか?

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

答えて

3

あなたはは、開発者にを話し、彼らがこれを行う理由は、それらを尋ねると考えている...私は、自然言語処理を期待することはできませんと思いますが、おそらく他のアイデア/ツールがあるのですか?

一方、このゲッターには本当にjavadocが必要ですか?とにかくメッセージの識別情報は何ですか?より良い名前を付けることができますか?

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

これは問題ではありませんでした。トピックにとどまってください。 – Bastl

+0

"しかし、おそらく他のアイデアやツールがあります。 - 私は、人々がツールを使ってタスクをスピードアップするために必要ではないと感じるかもしれないメソッドに対してjavadocを書かなければならないことを指摘しています。答えが気に入らなければ、投票してください。 – blank

関連する問題