程序開發(fā)中的注釋

發(fā)表日期：2016-03-03 文章編輯：重慶網(wǎng)站建設(shè)小編瀏覽次數(shù)：43 標(biāo)簽：

　　“代碼與注釋”的關(guān)系，我誠然的多次聽到這樣的一種說法，“盡量每個函數(shù)，都寫上詳細(xì)的注釋，這樣以后別人接收就很容易理解。”其實，這樣的說法存在弊端。

　　首先要明確一點，注釋到底是干什么用的。注釋的恰當(dāng)用法是彌補(bǔ)我們用代碼表達(dá)意圖時遭遇的失敗。換句話說，有意義的命名才是根本之道，如果我們無法準(zhǔn)確的找到有意義的命名，那么注釋可以增加代碼的可理解性。注釋不可以濫用，也不可以過度的依賴注釋。其實，我一直認(rèn)為，代碼根本不需要注釋，因為注釋存在，是因為我們找不到對命名的良好表達(dá)方式。注釋可以說是一個補(bǔ)救措施。

　　注釋的優(yōu)點是，增加可讀性與可理解性。

　　注釋的缺點是：可能因多個程序員的改動，造成注釋內(nèi)容陳舊，提供錯誤信息。

　　我一直不建議寫注釋的原因，是因為注釋會說謊。

　　一：就算是注釋，漢語的表達(dá)也可能存在詞不達(dá)意的情況。

　　二：代碼在變動，在迭代，在修改，不幸的是注釋并不總是隨之變動。

　　我們不可忽略的一點是，注釋存在的時間越久，就離其所描述的代碼越遠(yuǎn)，也許是全然的錯誤。為什么我不建議寫注釋，很簡單，隨著人員的流動，項目的高速迭代，程序員能不能堅持長久的維護(hù)注釋，誰也不能保證。

　　我們應(yīng)該盡量做到，準(zhǔn)確的命名，真正好的程序員是找到困難的解決方案，盡量不去寫注釋。

　　說了注釋的很多缺點，其實注釋本身沒有錯，錯的是我們使用它的時機(jī)與地方。比如，警示的作用。如：“// 在此處共花費時間26小時”。這個就相當(dāng)?shù)挠杏茫驗槠渌绦騿T看了，就知道，業(yè)務(wù)邏輯復(fù)雜，修改時候要細(xì)心，多琢磨一下。

　　什么也比不上良好的代碼有用，什么也不會比亂起八糟的注釋更有本事?lián)v亂，什么也不會比陳舊，提供錯誤信息的注釋更有破壞性。適當(dāng)?shù)臅r機(jī)，適當(dāng)?shù)奈恢檬褂米⑨?，可以事半功倍。用錯了，會浪費開發(fā)時間，影響項目進(jìn)度。

　　注釋并不是純?nèi)坏暮谩?/span>

　　本文由重慶網(wǎng)站建設(shè)-中技互聯(lián)：www.aorustv.com

如沒特殊注明，文章均為中技互聯(lián)原創(chuàng),轉(zhuǎn)載請注明來自www.aorustv.com