Clean Code_Note2_Really Need All comments?

 

Case1. Noise Comments

沒必要的註解(解釋程式碼語法類型)

Case2. Use Method Or Variable Instead Of Comment

複雜的判斷式或處理區塊盡可能在抽離成另一個function取代註解

隊要抽離出來的部分Ctrl+r , Ctrl+m重新命名method名稱

如此一來註解也就不需要了

Case3. commented out code

到底是因為要暫時disabled而註解掉的程式段落

還是因為真的沒用了?

時常讓人摸不著頭緒甚至不敢刪除那個段落，建議不要留下這種註解程式段落。

建議就是移除掉日後有要再加入透過版控再補回來即可。

Case4. Journal comments

有點像是在寫小說或工作日誌的註解類型

容易冗長且會有很多不必要訊息甚至可能誤導，現在都有版控工具處理不需要這樣子註解紀錄。

上述是一些要避免掉的註解習慣

那幾種有益日常開發的註解例子

比方以TODO為前綴的註解習慣搭配visual studio可以很方便去做一個類似任務書籤的紀錄

//TODO :

另外有一些註解很有需要!!

通常看到0參考的函數是否就會直接刪除想說沒有用到!!

這要小心

因為有些C#程式是會在runtime時期用reflection來間接呼叫的

此時若要避免被其他同事刪除就盡量要加上這類的comments。