一致性原則
// 或者/* */都可以，保持一致即可。
文件注釋
.h文件對所聲明的類的功能和用法作簡單說明，.cpp文件包含更多的實(shí)現(xiàn)細(xì)節(jié)。不要在頭文件和實(shí)現(xiàn)文件中簡單的復(fù)制注釋，那就失去了一半的意義。
函數(shù)注釋
頭文件中描述函數(shù)功能，定義處描述功能實(shí)現(xiàn)。
變量注釋
成員變量、全局變量都一樣，說明其用途即可。
注意拼寫和語法
錯誤的語法，錯誤的拼寫給他人帶來困惑與不快，寧愿不寫，不可亂寫。
中文還是英文
這個看個人喜好，如果英文不過關(guān)，就不要硬撐著。注釋的本質(zhì)是幫助別人和幫助自己更好的理解代碼，不是炫耀英文或中文水平。
posted on 2011-01-25 18:29 孔雀 閱讀(2312) 評論(2) 編輯 收藏 引用 所屬分類: C/C++