Java Checkstyle"；'；应为@param标记；id'&引用；错误

我正在代码库中使用checkstyle，我有一个关于JAVADOC的问题

我有如下静态函数：

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

checkstyle抱怨什么

“id”应为@param标记

当我给出这样的描述时

@param id id

---

然后它工作正常，但我不想给出每个参数和返回的描述。是否有其他方法可以解决此问题？

您是对的-此警告表示您没有参数说明。如果你不想描述这个参数，为什么还要麻烦提及它呢？您当前的JavaDoc毫无意义，只占用了无价的编辑器空间

要么从JavaDoc中完全删除该参数（我想它的含义在上下文中是显而易见的），要么正确地记录它。及

/**
 * id The id
 */

---

不是正确的文档。

如果要忽略它，为什么还要运行checkstyle呢

我基本上同意@Tomasz Nurkiewicz的回答，只是我肯定会记录下来

最终字符串id

的含义可能很明显。谢谢你。现在。方法

getName

目前可能也很明显

当我看它的时候，我不知道它是做什么的，或者我需要传递什么样的“id”。它是否获得用户的合法全名？他们输入了什么名字？他们[姓，名]的名字？我需要传递什么类型的id字符串？应用程序内部ID号/代码？ 对于方法本身的功能，您也没有任何javadoc

/**
 * Gets the indicated user's full name as entered when they registered.
 * @param id 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) {
    ...
}

---

我将其声明为

公共静态字符串getName（…）

，因为如果它不返回任何内容，如何获取名称？如果它做了其他事情，比如把名字放在以后可以得到的地方，（1）这不应该被命名为“getName”，并且（2）你肯定需要在你的javadoc中记录这个事实。

你可以通过改变你的评论来修复它

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

请关注**{text}**以修复此错误。

---

谢谢

我认为这是有道理的。但在我的代码中，参数名称本身是自描述性的。所以我必须复制粘贴参数名作为我所有方法调用的描述，我认为这是无用的。我检查了checkstyle文档，但找不到任何东西来禁用此描述警告。@user864077-您认为它现在是自描述性的，但相信我，它不是。当你雇佣初级程序员时，他们并不清楚。当您在5年后再次访问代码时，您可能不太清楚。数十年的经验证明了这一点。看我的答案。我想你误解了。Javadoc即使没有注释也可以理解

getName

的函数签名。当您输入

@param id whatever

时，

id

部分告诉javadoc您要为哪个参数添加描述。感谢您提供的信息。我刚刚创建了一个示例方法getName（）来说明我的问题。