1. 函數註釋函數
(1)函數聲明部分註釋函數的用法,實現部分註釋函數實現的操做。性能
(2)聲明部分註釋的信息spa
a. 輸入和輸出;對象
b. 對於類成員函數,在該方法的調用週期外,對象是否有引用參數,它是否會釋放這些引用;內存
c. 若是一個函數申請了內存,它必須釋放它們;文檔
d. 參數是否能夠是空;同步
e. 函數的使用方法是否會影響其性能;it
f. 若是函數可重入,是怎麼實現同步的;變量
2. 變量註釋引用
(1)全部全局變量應該有一個描述其功能及其意義的註釋。
3. 以NULL、true/false、1/2/3等做爲參數
(1)函數傳入NULL、布爾值和整型值時,應該增長註釋說明這些值的意義,或者使用常量使代碼自文檔化。