JavaDoc的问题

Question

所以我正在尝试正确地完全javadoc评论这段代码，但我不知道该做什么和不该做什么。谢谢！

public double largerRoot (double a, double b, double c) throws Exception
{
    double discriminant;
    double root1;
    double root2;

    discriminant = Math.sqrt ( b * b - 4 * a * c );

    if ((discriminant < 0) || (a == 0))
    {
        throw (new Exception("Math Error"));
    }

    root1 = (-b + discriminant) / (2 * a);
    root2 = (-b - discriminant) / (2 * a);

    return Math.max(root1, root2);
    }

Answer 1

在eclipse中，按Alt + Shift + J

其他：google（like this）

Answer 2

首先：我会使用一个名称来重命名b和c参数。

第二：方法/类描述：总是写javadoc并记住“为什么”。我的意思是大多数dev编写javadoc来解释代码的作用......这是无助的，因为大多数程序员都知道如何阅读代码。我总是试图将类或方法描述为我为什么这样做以及它应该做的目的（合同）。

第三：有关参数的详细信息是必须的（无论是否接受，是否有任何范围..等等）

第四：关于返回值的详细信息。

第五：引用：@see对于想要了解您在方法中使用的类的javadoc用户非常有用。

希望有所帮助。