Checkstyle"'id'的预期@param标签"错误

Question

我在我的代码库中使用checkstyle,http: //checkstyle.sourceforge.net/,我对JAVADOC有疑问.

我有这样的静态函数:

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

checkstyle抱怨的地方

'id'的预期@param标签

当我给出类似的描述时

@param id id

然后它工作正常,但我不想给每个参数的描述并返回.有没有办法解决这个问题？

Answer 1

你是对的 - 这个警告意味着你没有参数的描述.如果你不想描述参数为什么还要提呢呢？您当前的JavaDoc毫无意义,只占用无价的编辑器空间.

从JavaDoc中完全删除参数(我猜它的含义在上下文中很明显)或者正确记录它.和

/**
 * id The id
 */

不是一个适当的文件.