我正在自學 Java，并希望得到有關此問題的反饋：編寫一個具有兩種方法的 Java 接口，一種將兩個雙精度加在一起返回總和，另一種將兩個雙精度相乘返回乘積。使用 JavaDoc 注釋。我錯過了什么嗎？在接口的 JavaDoc 注釋中包含 @return 是否合適？/** * This is an interface for basic math. */public interface Math { /** * This method will be used to add two doubles. * @param a a value to be added * @param b the other value to be added * @return the sum of the two doubles */ public double add(double a, double b); /** * This method will be used to multiply two doubles. * @param a a value * @param b the other value * @return the product of the two doubles */ public double multiply(double a, double b);}
2 回答
侃侃爾雅
TA貢獻1801條經驗 獲得超16個贊
我錯過了什么嗎？
當前形式的 javadocs 沒有任何根本性的錯誤或“缺失”。
在接口的 JavaDoc 注釋中包含 @return 是否合適？
這是絕對合適的。接口是 API 的一種形式，API 方法返回的值的含義是接口的一個基本方面。如果接口中沒有指定方法返回值的含義，那么接口方法的調用者將不知道會發生什么。這使得對接口的編程變得困難。
MM們
TA貢獻1886條經驗 獲得超2個贊
是的，有@return.
您可以改進的幾件事：
要遵循 Java 編碼約定，請以小寫開頭的方法名稱（例如，使用
add代替Add）。有更好的參數名稱。例如，使用
number1,number2代替a,b。以大寫字母開頭
@param和描述（例如）。@return@param number1 First number我認為這比說
Returns the addition of two given numbers更好This method will be used to add two doubles.
添加回答
舉報
0/150
提交
取消