如何修复Checkstyle错误“ Expected a @return tag。”？

Question

我的代码的一部分在进行样式检查时返回： “ [ERROR] 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标记，以描述函数返回的内容。