總想着把所有的頭文件都塞到一個頭文件裏邊,然後,所有.c文件只包含這一個混雜的頭文件就行了,也不用注意太多,,
但是這樣好像不行,摘抄一篇文章備份一下,覺得寫的不錯,
尊重原創,原文鏈接:http://blog.csdn.net/ison81/article/details/5852425?reload
1. 註釋,版權,作者,重大修訂記錄等信息
2. 防重入開關,也就是常見的 #ifndef… #define… #endif
3. C++ 編譯器自適應開關,也就是常見的 #ifdef __cplusplus… extern “C” { } #endif
4. #include ,頭文件裏應該 include 所有該文件中所使用的其它接口頭文件。這裏有也有兩層含義,一是說頭文件應做到自包含,
即使用頭文件的用戶不需要再爲該頭文件 include 其它頭文件;二是從模塊耦合內聚角度來說,
頭文件中本身不應該 include 太多其它頭文件,一般就是通用數據類型定義,
include 其它頭文件意味着強耦合——引用了其它頭文件中的類型定義,宏或是函數。
5. 接口聲明及註釋,包括函數,結構體等,但不應該出現全局變量,和 static 類型的接口,這些都應該是放置在C 文件中
函數的註釋中應該包括功能說明,參數使用方法,可能的返回值,及其它注意事項。
結構體的註釋中應該包括每個成員變量所表示的含義。我們也提倡自注釋,即通過合理的命名達到見名知意的效果。
6. 接口總體上來說是越少,越簡單越好,時刻檢查頭文件中是否存在冗餘的信息,及時刪除,合併。