前言

論如何寫出優秀的程式碼註釋？

寫程式碼和註釋的第一目的是幫助人理解程式碼，理解作者的意圖。所以優秀的程式碼本身就有自說明的功能，但是在程式碼本身無法闡述作者意圖時，需要考慮寫註釋，註釋也是為了為後繼開發者以及程式碼維護者提供了方便。我們知道，寫程式碼要寫註釋，甚至聽說程式碼的20%是註釋，然後我們就認真對待寫註釋，後來看書多了，瞭解了敏捷開發，知道了好的程式碼是不需要註釋這麼一說的，當然，好的程式碼本身就是註釋，這話是對的，但是我覺得這僅侷限於邏輯簡單直白的程式碼，如果沒有註釋我相信看程式碼的人是要花很多時間精力去理解的，不管你的程式碼寫的有多好都是如此。邏輯複雜的程式碼，寫註釋是很有必要的，註釋怎麼寫？對於實現來說，把自己寫程式碼時怎麼思考的用精簡的語言寫下來；對於介面來說，就像敏捷開發中提到的，程式碼介面本身就是註釋，加註釋是來描述這個介面在整個程式碼中是處於什麼角色。

內容

有些註釋是可以自動生成的，或者說自動生成註釋是用來處理重複率高的註釋，為了降低程式碼編寫過程中的工作量，通常我們新建一個類時，會在類引用的名稱空間前加註釋來說明有關這個類模組的資訊，那如何自動生成類檔案前的頭註釋呢？

1、開啟VS2017的安裝資料夾，按照如下路徑開啟，找到目標檔案“ItemTemplates”

2、開啟我的文件，找到“Templates”資料夾下的目標檔案“ItemTemplates”，將此資料夾複製到VS安裝路徑下找到的相同名字的檔案中

3、然後在VS安裝路徑下繼續找到CSharp中的class，如下路徑所示，選擇“class”，右擊選擇“編輯”，在記事本中開啟，將註釋新增到類前，然後儲存，一個註釋模板就建立好了，每次重新新增類時，都會出現類的頭註釋。