のCheckstyleエラー

Question

私は、私のコードベースでhttp://checkstyle.sourceforge.net/をのCheckstyleを使用しています、と私はJAVADOCに関する疑問を持っています「『ID』の予想@paramタグ」。

私はこのような静的な機能があります：私は

のような記述を与えるときのCheckstyleは、 'ID'

約

期待@paramタグを文句

** 
* @param id 
*/ 
public static void getName(final String id) { 
} 

を

@param id id 

それは正常に動作しますが、私は各パラメータの説明をつけて返信したくありません。これを修正する方法はありますか？

Answer 1

この警告は、パラメータの説明がないことを示しています。パラメータを記述したくない場合は、なぜそれに言及していますか？あなたの現在のJavaDocは無意味で、貴重なエディタスペースしか占有しません。

のJavaDocから完全にパラメータを削除（私はそれが意味だと思う文脈から明らかである）、または適切に文書化のどちらか。そして

/** 
* id The id 
*/ 

は適切なドキュメントではありません。

Answer 2

あなたがそれを無視する場合は、なぜチェックスタイルを実行するのが面倒ですか？

私は主に、私は間違いなくそれを文書化することを除いて、@Tomasz Nurkiewicz」答えに同意します。

final String idの意味は明らかであります。 にはです。 の場合は、です。メソッドgetNameも明白かもしれません。

私はそれを見たとき、私はそれが何をするか分からない、または私は渡す必要があり、「ID」がどんなものなのか。それは、ユーザーの完全な法的名前を取得していますか？彼らがどんな名前を入力したとしても？彼らの[最後の、最初の]名前？どんな種類のid文字列を渡す必要がありますか？アプリケーション内部ID番号/コード？ メソッド自身のためにjavadocがありません。

/** 
* Gets the indicated user's full name as entered when they registered. 
* @param The application internal id generated when the user registered. 
* @return "void" ??? How do you get a name if it returns VOID? 
*/ 
public static void getName(final String id) { 
    ... 
} 

それは何も返さない場合はどのようにあなたが名前を取得しますので、私はpublic static String getName(...)としてこれを宣言するだろうか？何か他のことをしたら、名前をどこかに置くのと同じように、後でそれを得ることができます。（1）これは "getName"という名前にするべきではありません、そして、（）確かにはjavadocでその事実を記録する必要があります。

Answer 3

あなたはこのバグを修正するために** {テキスト} **に焦点を当ててくださいコメント

/** 
* this is comment of function 
* @param id **this is id of table** 
* @param username **this is name of user need for login** 
*/ 

を変更することにより、それを修正することができます。 このリンクにアクセスしてhttp://tinadev.blogspot.com/2015/08/checkstyle-expected-param-tag-for-id.html を修正することができます。ありがとうございます