闡明

闡明

闡明

闡明

有時候註解把難理解的參數或回傳值翻譯成具有可讀性的
文字，這種註解是有幫助的。一般來說，如果可以讓參數
和回傳值自我闡述清楚其本意，會是一個更好的選擇;但
參數或回傳值是標準函式庫裡的一部份，或是不能修改
的程式碼，加入一段幫助闡明的註解將會變得很有用處。

example:
assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != b

當闡明性的註解並不正確時，會冒了較大風險。要證明註解
的正確性是很困難的。在寫闡明性註解之前，請先思考是否
已沒有其它辦法，才選擇這樣做。請加倍注意這些註解的正
確性。