java - 如何修复 checkstyle 错误 "Expected an @return tag."？

Question

我的一段代码在检查样式时返回:“[错误] UserInfo.java:39:需要 @return 标记。[JavadocMethod]”

我只是想将 javadoc 注释添加到我的代码中，以前从未遇到过此问题。我不知道要在 javadoc 注释中添加什么内容来解决下一部分(这就是为什么“定义信息格式”之后它是空白的)

 /**
 * Defines format of information.
 *
 * 
 *
 */
 public String toString()
 {
    String output = "Name: " + firstName + " "
       + lastName + "\n";
    output += "Location: " + location + "\n";
    output += "Age: " + age + "\n";
    output += "Status: ";
    if (status == OFFLINE)
    {
       output += "Offline";
    }
    else
    {
       output += "Online";
    }

    return output;
 }

Answer 1

最简单的方法是在 javadoc 注释中添加一个 @return 标记来描述函数返回的内容。