Question

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

我有这样的静态函数：

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

checkstyle抱怨

'id'的预期@param标记

当我给出类似

的描述时

@param id id

然后它工作正常，但我不想为每个参数给出描述并返回。有没有其他方法可以解决这个问题？

Answer 1

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

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

/**
 * id The id
 */

不是一份正确的文件。

Answer 2

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

我基本同意@Tomasz Nurkiewicz的回答，除了我肯定会记录它。

final String 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) {
    ...
}

我将此声明为public static String getName(...)，因为如果它没有返回任何内容，您如何获得该名称？如果它做了别的事情，就像把名字放在某处你可以稍后得到它（1）这不应该被命名为“getName”和（2）你肯定需要在你的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**
*/

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

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

3 个答案: