1. 程式人生 > >C語言標頭檔案包含和編寫的幾個基本規則

C語言標頭檔案包含和編寫的幾個基本規則

總想著把所有的標頭檔案都塞到一個頭檔案裡邊,然後,所有.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.       介面總體上來說是越少,越簡單越好,時刻檢查標頭檔案中是否存在冗餘的資訊,及時刪除,合併。