Comments

徵兆與症狀

程式碼內充滿了解釋性的註解。

出現原因

當開發者正在處理的程式碼並不容易直觀的被理解，通常會使用註解來描寫程式碼意圖。

註解不見得是壞東西，但濫用註解往往會掩蓋程式碼可以改進的訊號。

處理方法

• 如果註解是要解釋一些複雜的表示式，可以用 Extract Function 抽取出來，並給予貼切名字。
• 如果程式碼已經被抽取出來，但名字不夠貼切而需要註解來解釋，可以用 Change Function Declaration 來改名字。
• 如果註解想要說明的，系統依賴某些狀態成立才能夠正常運行，那可以使用 Introduce Assertion 來確保系統狀態如註解所描述。