1. 程式人生 > >1. 我使用的C/C++頭文件編寫規範

1. 我使用的C/C++頭文件編寫規範

性能 C/C++ file 警告 define 華為 檢查 開頭 pro

自用的規範,參考自Google、華為與微軟。
————————————————————————————
正確使用頭文件可令代碼在可讀性、文件大小和性能上大為改觀。

  1. #define的保護
    所有頭文件都應該使用#define防止頭文件被多重包含,命名格式為:
    <PROJECT>_<PATH>_<FILE>_H

    為保證唯一性,頭文件的命名應基於所在項目源代碼樹的全路徑。例如,項目slam中的頭文件slam/kalman/test/test.h按如下方式保護:

    #ifndef SLAM_KALMAN_TEST_TEST_H_
    #define SLAM_KALMAN_TEST_TEST_H_
    ...
    #endif

    註意事項:
    1)不要在宏最前面加上下劃線,因為這種做法為ANSI C等使用,在有些靜態檢查工具中,若全局可見的標識符以“_”開頭會給出警告;
    2)保護符使用使用唯一名稱;
    3)不要在受保護部分的前後放置代碼或者註釋。

(未完待續)

1. 我使用的C/C++頭文件編寫規範