引言
? ? ? ?? “什么也比不上放置良好的注釋來得有用蹬跃。什么也不比亂七八糟的注釋更有本事搞亂一個模塊系宫。什么也不比陳舊笛厦、提供錯誤信息的注釋更有破壞性”纳鼎。注釋的恰當(dāng)用法是彌補(bǔ)我們在用代碼表達(dá)意圖時遭遇的失敗。比如我們在一個文件中提供了兩個方法func1和fun2分別用于不同的系統(tǒng)版本递递，但是在這兩個方法中我們可能沒辦法描述清楚它們分別對應(yīng)哪個版本喷橙，所以我們只能給他們分別添加注釋來說明在不同的版本應(yīng)該調(diào)用哪個方法啥么。但是注釋多并不是一件好事登舞，我們應(yīng)該盡量避免使用注釋贰逾。因為通常我們寫的代碼會變動，在演化菠秒，但是注釋并不一定會隨著代碼合理的移動疙剑、變化。那么這將導(dǎo)致我們的注釋越來越不準(zhǔn)確践叠。
?????? 注釋并不能美化糟糕的代碼言缤，往往我們寫注釋的動機(jī)之一是代碼比較糟糕，讀者在閱讀代碼時不容易清楚其中的邏輯禁灼。在我們寫注釋之前管挟，我們應(yīng)該首先分析我們的注釋是否是必要的，我們的代碼是否足夠清晰弄捕、有表現(xiàn)力僻孝。我們作為程序員應(yīng)該負(fù)責(zé)將注釋保持在可維護(hù)、有關(guān)聯(lián)守谓、精確的高度穿铆。但是更應(yīng)該把力氣花費(fèi)在寫清楚代碼之上，直接保證無需編寫注釋斋荞。
編寫好的注釋
?????? 要么不寫注釋荞雏，要寫就要寫好注釋。好的注釋應(yīng)該遵循以下幾點(diǎn)：
?????????????? 1平酿、項目中注釋格式盡量保持統(tǒng)一??????????????
?????????????? 2凤优、注釋簡單、明了
?????????????? 3蜈彼、不寫誤導(dǎo)性注釋
?????????????? 4筑辨、不要保留注釋掉的代碼
