多餘的註解

多餘的註解

多餘的註解

多餘的註解

// Utility method that returns when this.closed is true. Throws
// an exception
// if the timeout is reached.
public synchronized void waitForClose(final long timeoutMillis)
throws Exception
{
if(!closed)
{
wait(timeoutMillis);
if(!closed)
throw new Exception(“MockResponseSender could not be closed”);
}
}

上面是一個含有開頭註解的簡單函式，這完全是個多餘的註解，讀
這段註解可能比讀程式碼花上更多時間。

這段註解很明顯它沒有提供比程式碼本身透露出更多訊息，它沒有
解釋這段程式碼，也沒有提供這段程式碼的意圖或理由，它甚至比
程式碼本身更難理解。事實上，這段註解比程式本身更不精確，誤導
讀者接受不準確的資訊，而非真正瞭解程式碼。