程序員寫代碼需要代碼注釋嗎?對于這個問題不外乎兩種觀點。
一種程序員認為，如果類、方法、變量定義準確，代碼注釋顯得有點多余。最好的代碼注釋就是沒有注釋。
另一種程序員認為，必須寫代碼注釋。
谷歌創(chuàng)始人布林
別以為你可以理解自己寫的代碼，過了兩個星期之后，你可能就不知道代碼是不是自己寫的。
如果是簡單的代碼，不加注釋情有可原，但是，復雜的代碼那就必須加注釋了。
下面w3cschool分享代碼注釋的5大技巧：
1、代碼注釋最基本的原則
代碼注釋一定是注明代碼的目的，而不是代碼的行為。為何呢?因為通過代碼我們就可以清楚行為，多加注釋，畫蛇添足。
2、使用空格對齊注釋行
為了方便閱讀起見，代碼注釋對齊會更好一些。那么問題來了，是用tab對齊還是用空格鍵對齊呢?
我們都清楚，tab在不同的編輯器和集成開發(fā)環(huán)境中是不一樣的，所以選擇空格鍵對齊會適合一些。
const MAX_ITEMS = 10; // maximum number of packets
const MASK = 0x1F; // mask bit TCP
3、代碼少而精
如果說代碼注釋一定要有，那就就要盡量做到少而精。有些人代碼注釋寫的跟小說一樣，這后果是相當嚴重的...
4、代碼“統(tǒng)帥”段落
一些程序員習慣將代碼分成多個“段落”，這是非常要好的一個習慣。
以上是谷歌創(chuàng)始人之一布林的代碼，他沒有在簡歷中寫待遇，直接在html源代碼注釋：辦公室要大，掙錢要多，干活要少...
當然，加個代碼注釋就會錦上添花。比如在段落代碼前加個注釋。同樣地，就是告訴自己或者維護人員代碼的意圖。
5、代碼注釋的精髓
不知道有沒有小伙伴使用下面這種方式寫代碼注釋，必須要給出大寫的“服”!
聯(lián)系客服
