今天我們繼續聊聊怎麼撰寫文件，可以讓專案變得難以維護。
只紀錄程式碼做了什麼事情的細節，但是不描述這段程式碼的功能。
這樣一來，如果出錯的話，負責改的人完全不知道這段程式應該要做什麼事情。只能從程式碼現在做了什麼事情來推測。然而，程式碼的行為當然也是錯誤的（不然一開始就不用修了，對吧），他只好嘗試從其他同事的印象來拼湊出這段到底該怎麼改。
如果你在閱讀程式碼的時候，意外發現了可能會導致出錯的地方，絕對不把這件事紀錄下來。
紀錄了錯誤的地方，如果寫的人看到了不開心，那怎麼辦呢？不如就讓這個錯誤留下來，等到之後爆發了，再交由維護的工程師處理。
如果你還是想留下一點紀錄，那就留註解說「這裡可能有問題」，但是不說明你認為是什麼問題。記得不要在版控裡面留下這註解是你寫的紀錄。
這部分不需要什麼特別努力，你只要不去維護文件，隨著時間過去，需求變更，文件自然而然無法跟程式的實際行為一致，也自然就會說謊了。
iThome鐵人賽
看影片追技術