java - 所以我需要帮助完成java文档注释

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 注释的正确方法如下:

/**
 * ...
 */

对函数进行注释时，格式通常类似于:

/**
 * This is a description of the function and what it does.
 * @param argument1 this is a description of a parameter
 * @param argument2 this is a description of a second parameter
 * @return this is a description of what the function returns
 */
 public boolean myFunction(argument1, argument2){
     ...

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