現在寫代碼已經不流行寫注釋了。就像小學生讀的書需要漢語拚音,到了中學以上就不要了。
為什麽注釋不重要了?
因為注釋所起的功能,都被不同的方式替代了。
比如,以前代碼的開頭需要介紹下主要功能,現在有Design Document,可以把本來放在注釋的東西放到那裏麵。
現在代碼需要寫成可分享的模塊,你的代碼大體包含兩個部分,界麵與實現。
實現裏麵不必加注釋,因為沒人關心。對別人來說,這是黑箱,人家從不打開。
界麵不必要加注釋,用Optional Parameter,throw Exception等來替代。
代碼可以寫得Self-Explanatory。
一是變量名、函數名盡量用長一些。
二是長一點的函數都要拆成短的,用合適的名字。
要避免注釋,最重要的技術是Refactoring,如果發現函數需要承擔以前不能承擔任務的時候,要把名字及時Refactoring。
再加上Behavior Driven Development,可以用類似口語的語言來寫測試。
不著注釋,盡得風流。
更多我的博客文章>>>