誤導型註解

誤導型註解

誤導型註解

誤導型註解

有時工程師會寫下好意但不夠精確的註解。
https://davidchenblog.com/posts/32959aed/#more
開頭的註解，當this.closed變成true，這個方法並未返回。
只判斷到this.closed是true時才返回；其它的狀況，它會
盲目等待一段時間，等待時間結束後，如果this.closed依舊
不是true，這個方法會拋出一個例外。

這樣細微的錯誤訊息，潛藏在註解裡面，使之比程式碼本身，
更難去閱讀。並且可能導致其它程式設計師無掛慮地呼叫此函
式，並預期此函式在this.closed變為true時會立刻返回。