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。

希望它有幫助。