程序員要學(xué)會(huì)寫注釋云茸。
對(duì)于注釋是目，必須明白：注釋，最多是一種不得不為的“惡”标捺。再好的注釋懊纳，也是迫不得已才寫。能不寫就不寫亡容。
好的注釋是這樣的：
- 對(duì)意圖的闡釋嗤疯。
- 對(duì)程序員的警示。比如有一段非常危險(xiǎn)的代碼闺兢，一定要通過注釋將這種危險(xiǎn)傳達(dá)給程序員茂缚。
- 對(duì)某段代碼作用或功能的放大。
- 好的注釋美化不了糟糕的代碼屋谭。首選做法不是寫“注釋”脚囊，而是優(yōu)化代碼，通過代碼傳達(dá)意圖桐磁。
- 法律信息悔耘。比如版權(quán)等信息。
- 提供信息所意。
TODO注釋淮逊。有時(shí)某段代碼由于某種原因暫時(shí)不能寫，就可以使用TODO注釋標(biāo)記扶踊。需及時(shí)整理TODO注釋泄鹏，
時(shí)間久了，TODO注釋會(huì)變?yōu)闊o用的壞注釋秧耗。
