程序員寫(xiě)代碼需要代碼注釋嗎?對(duì)于這個(gè)問(wèn)題不外乎兩種觀點(diǎn)。

一種程序員認(rèn)為，如果類、方法、變量定義準(zhǔn)確，代碼注釋顯得有點(diǎn)多余。最好的代碼注釋就是沒(méi)有注釋。

另一種程序員認(rèn)為，必須寫(xiě)代碼注釋。

谷歌創(chuàng)始人布林

別以為你可以理解自己寫(xiě)的代碼，過(guò)了兩個(gè)星期之后，你可能就不知道代碼是不是自己寫(xiě)的。

如果是簡(jiǎn)單的代碼，不加注釋情有可原，但是，復(fù)雜的代碼那就必須加注釋了。

下面w3cschool分享代碼注釋的5大技巧：

1、代碼注釋最基本的原則

代碼注釋一定是注明代碼的目的，而不是代碼的行為。為何呢?因?yàn)橥ㄟ^(guò)代碼我們就可以清楚行為，多加注釋，畫(huà)蛇添足。

2、使用空格對(duì)齊注釋行

為了方便閱讀起見(jiàn)，代碼注釋對(duì)齊會(huì)更好一些。那么問(wèn)題來(lái)了，是用tab對(duì)齊還是用空格鍵對(duì)齊呢?

我們都清楚，tab在不同的編輯器和集成開(kāi)發(fā)環(huán)境中是不一樣的，所以選擇空格鍵對(duì)齊會(huì)適合一些。

const MAX_ITEMS = 10; // maximum number of packets

const MASK = 0x1F; // mask bit TCP

3、代碼少而精

如果說(shuō)代碼注釋一定要有，那就就要盡量做到少而精。有些人代碼注釋寫(xiě)的跟小說(shuō)一樣，這后果是相當(dāng)嚴(yán)重的...

4、代碼“統(tǒng)帥”段落

一些程序員習(xí)慣將代碼分成多個(gè)“段落”，這是非常要好的一個(gè)習(xí)慣。

以上是谷歌創(chuàng)始人之一布林的代碼，他沒(méi)有在簡(jiǎn)歷中寫(xiě)待遇，直接在html源代碼注釋：辦公室要大，掙錢(qián)要多，干活要少...

當(dāng)然，加個(gè)代碼注釋就會(huì)錦上添花。比如在段落代碼前加個(gè)注釋。同樣地，就是告訴自己或者維護(hù)人員代碼的意圖。

5、代碼注釋的精髓

不知道有沒(méi)有小伙伴使用下面這種方式寫(xiě)代碼注釋，必須要給出大寫(xiě)的“服”!