Question

所以这是代码的一部分。你可以看到我不知道在评论中放什么。我还是编程的新手并且很喜欢它。所以我需要一些帮助。我应该把它放进去。相信我，我向我的教授求助，她说的只是客户，不知道如何提供帮助。

/* (non-Javadoc)
 * @see java.lang.Object#equals(java.lang.Object)
 */
@Override
public boolean equals(Object obj) {
    if (this == obj)
        return true;
    if (obj == null)
        return false;
    if (getClass() != obj.getClass())
        return false;
    Student other = (Student) obj;
    if (name == null) {
        if (other.name != null)
            return false;
    } else if (!name.equals(other.name))
        return false;
    if (testOne != other.testOne)
        return false;
    if (testTwo != other.testTwo)
        return false;
    return true;
}

/* (non-Javadoc)
 * @see java.lang.Object#toString()
 */
@Override
public String toString() {
    return "Student [name=" + name + ", testOne=" + testOne + ", testTwo=" + testTwo + "]";
}
}

所以对于底部评论，它看起来像这样吗？

     /**
      * @returns a string representation of Students name, testOne, and testTwo
      */
     @Override
    public String toString() {
        return "Student [name=" + name + ", testOne=" + testOne + ", testTwo=" + testTwo + "]";
    }

}

Answer 1

最重要的是，构建Javadoc注释的正确方法是这样的：

>>> d = ["'WORKSHOP'", "'KIDS'", "'EXHIBITION'", "'FANTASY'", "'FESTIVAL'"]
>>> allchars =string.maketrans('','') #to make a chars list of 256, for translate method
>>> l = map(lambda s:s.translate(allchars, '\''),d)
>>> l
['WORKSHOP', 'KIDS', 'EXHIBITION', 'FANTASY', 'FESTIVAL']

在评论某个功能时，格式通常类似于：

/**
 * ...
 */

您可以阅读有关Javadoc语法here的更多信息。

Answer 2

通常编写Java Doc来解释类或方法的用途。在方法的情况下，javadoc用于首先提到该方法用简单的英语做什么。除此之外，我们还提到了方法的参数，写入方法的日期，作者姓名，方法抛出的异常（如果有的话）以及方法的返回（如果有的话）。 Java doc是使用javadoc comment（

）编写的方法声明

/**
* JavaDoc comment goes here
* @param <paramName>
* @author Mr XYZ
* @throws Exception
*/
public void methodName(Datatype paramName) throws Exception{
  //Method body
}

为了提及参数我们使用@param标签，对于我们使用@throws的例外，我们使用@author的方法的作者，我们使用@since或@date的日期和返回我们使用@return

您可以在java doc注释中使用<p> , <b> , <i>, <blockquote>, <pre>,<em>之类的html标签对其进行格式化，使其更具可读性和更好的外观。

所以我需要帮助完成java doc评论

2 个答案: