C標頭檔案編寫基本規則

2021-08-07 18:21:24 字數 711 閱讀 9556

1.       注釋,版權,作者,重大修訂記錄等資訊

2.       防重入開關,也就是常見的

#ifndef  _***_***_h  //必須確保header guard巨集名永不重名

#define _***_***_h

//《標頭檔案內容》

#endif

3.       c++ 編譯器自適應開關,也就是常見的

//.h檔案頭部

#ifdef __cplusplus

extern "c"

#endif

4.       #include ,標頭檔案裡應該 include 所有該檔案中所使用的其它介面標頭檔案。這裡有也有兩層含義,一是說標頭檔案應做到自包含,即使用標頭檔案的使用者不需要再為該標頭檔案 include 其它標頭檔案;二是從模組耦合內聚角度來說,標頭檔案中本身不應該 include 太多其它標頭檔案,一般就是通用資料型別定義, include 其它標頭檔案意味著強耦合——引用了其它標頭檔案中的型別定義,巨集或是函式。

5.       介面宣告及注釋,包括函式,結構體等,但不應該出現全域性變數,和 static 型別的介面,這些都應該是放置在 c 檔案中。函式的注釋中應該包括功能說明,引數使用方法,可能的返回值,及其它注意事項。結構體的注釋中應該包括每個成員變數所表示的含義。我們也提倡自注釋,即通過合理的命名達到見名知意的效果。

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

1.注釋,版權,作者,重大修訂記錄等資訊 2.防重入開關,也就是常見的 ifndef define endif 3.c 編譯器自適應開關,也就是常見的 ifdef cplusplus extern c endif 4.include 標頭檔案裡應該 include 所有該檔案中所使用的其它介面標頭檔...

c 編寫標頭檔案

標頭檔案一般包含類的定義 extern變數的宣告和函式的宣告。標頭檔案的正確使用能夠帶來兩個好處 一是保證所有檔案使用給定實體的同一宣告 二是當宣告需要修改時,只有標頭檔案需要更新。標頭檔案是用於宣告而不是用於定義,但有三個例外。標頭檔案可以定義類 值在編譯時就已經知道的const物件和inline...

C語言標頭檔案的編寫

標頭檔案是一種文字檔案,使用文字編輯器將 編寫好之後,以副檔名 h儲存就行了。標頭檔案中一般放一些重複使用的 例如函式宣告,變數宣告,常數定義,巨集的定義等等。當使用 i nclude 語句將標頭檔案引用時,相當於將標頭檔案中所有內容,複製到 i nclude處。為了避免因為重複引用而導致的編譯錯誤...