程序其實(shí)包括代碼和文檔2部分，可能很多人都會(huì)重代碼輕文檔，但是如果代碼只能自己看得懂，那么代碼將變得一文不值。

好的編程習(xí)慣就包含能夠?qū)懗龈哔|(zhì)量的注釋，讓其他人能夠通過(guò)注釋就了解你的代碼功能。

對(duì)于一個(gè)實(shí)現(xiàn)具體功能的函數(shù)代碼，需要在函數(shù)前面加上需要傳入的參數(shù)，返回的參數(shù)，函數(shù)功能說(shuō)明，函數(shù)被哪里調(diào)用等關(guān)鍵信息。

對(duì)于變量，我們應(yīng)該在變量后面加上變量的功能是什么，代表的具體含義，這些都是通過(guò)注釋實(shí)現(xiàn)的。

由此可見我們代碼的注釋有多重要。