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

其他：谷歌（like this）

Answer 2

第一：我会重新命名与说话名字的B和C参数。

第二：方法/类的描述：总是写javadoc与“为什么”的想法。我的意思是大部分开发人员都会写javadoc来解释代码的作用......这是一种无奈，因为大多数程序员知道如何阅读代码。我总是试图描述为什么我做了这个类或方法，以及它应该做什么目的（合同）。

三：有关参数的细节是必须的（空接受与否，有没有range..etc）

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

第五个参考：对于想要了解您在方法中使用的类的javadoc用户，可以使用@see。

希望它有帮助。