林銳博士的C++高質量代碼的讀書筆記,在畢業那年找工作的時候給與了很大幫助,即使工作了也很有益處。
無意中在本地電腦里找到了當年的筆記,重新整理下。
1.1 版權和版本的聲明
主要內容有:(1) 版權信息。
(2) 文件名稱,標識符,摘要。
(3) 當前版本號,作者/修改者,完成日期。
(4) 版本歷史信息。
示例1-1
/*
- Copyright (c) 20XX, XXXX事業部
- All rights reserved.
- 文件名稱:filename.h
- 文件標識:見配置管理計劃書
- 摘 要:簡要描述本文件的內容
- 當前版本:1.1
- 作 者:作者(或修改者)名字
- 完成日期:20XX年X月X日
- 取代版本:1.0
- 原 作 者 :作者(或修改者)名字
- 完成日期:20XX年X月X日
*/
1.2 頭文件的結構
頭文件由三部分內容組成:(1) 頭文件開頭處的版權和版本聲明
(2) 預處理塊
(3) 函數和類結構聲明等
規則 1-2-1 為了防止頭文件被重復引用,應對用ifndef/define/endif結構產生預處理塊。
規則 1-2-2 用#include<filename.h>格式來引用標準庫的頭文件(編譯器將從標準庫目錄開始搜索)。
規則 1-2-3 用#include "filename.h"格式來引用非標準庫的頭文件(編譯器將從用戶的工作目錄開始搜索)。
建議 1-2-1 頭文件中只存放“聲明”而不存在“定義”。
建議 1-2-2 不提倡使用全局變量,盡量不要在頭文件中出現像extern int value這類聲明。
1.3 定義文件的結構
定義文件有三部分內容:(1) 定義文件開頭處的版權和版本聲明
(2) 對一些頭文件的引用
(3) 程序的實現體(包括數據和代碼)
1.4 頭文件的作用
(1) 通過頭文件來調用庫功能。
(2) 頭文件能加強類型安全檢查。
1.5 目錄結構
如果一個軟件的頭文件數目比較多,通常應將頭文件和定義文件分別保存于不同的目錄,以便于維護。