天天看點

建構之法閱讀筆記02

      我過去自己在寫代碼時,無論是大型程式還是小型的程式,很少寫注釋,主要是因為自己覺得很麻煩,既然是自己寫出來的代碼,自己本來就會,寫什麼注釋啊~~~過了一段時間之後,有人問自己某道題怎麼做時,自己會把曾經寫過的代碼拿出來給他看,但是他根本看不懂。當自己重新看一遍時,有時也忘記了曾經是怎麼想的。還需要好長時間去重新分析;

      看了本書第4章《代碼規範》部分後,發現了代碼規範很重要。這裡我想強調下注釋的重要性!如果不加注釋,對他人,對自己都是對時間的一種浪費!而且不光要注釋,還要知道怎麼寫注釋!

      解決辦法:

   1.不要注釋程式是怎麼工作的(how),注釋是為了解釋程式是做什麼的(what),為什麼這樣做(why),以及要特别注意的地方。

   2.複雜的注釋應該放在函數頭

   3.注釋也要随着程式的修改而不斷地更新

   4.注釋包括所有源代碼應該隻用ASCII字元,不要用中文或其他特殊字元,否則會極大影響程式的可移植性。