C++的頭文件和實現文件分別寫什麼

轉載自 ider 的博客



在C++編程過程中,隨着項目的越來越大,代碼也會越來越多,並且難以管理和分析。於是,在C++中就要分出了頭(.h)文件和實現(.cpp)文件,並且也有了Package的概念。

對於以C起步,C#作爲“母語”的我剛開始跟着導師學習C++對這方面還是感到很模糊。雖然我可以以C的知識面對C++的語法規範,用C#的思想領悟C++中類的使用。但是C#中定義和實現是都在一個文件中(其實都是在類裏面),而使用C的時候也只是編程的剛剛起步,所寫的程序也只要一個文件就夠了。因此對於C++的Package理解以及.h文件和.cpp文件的總是心存糾結。

幸好導師有詳細的PPT讓我瞭解,一次對於Package的認識就明白多了。簡單講,一個Package就是由同名的.h和.cpp文件組成。當然可以少其中任意一個文件:只有.h文件的Package可以是接口或模板(template)的定義;只有.cpp文件的Package可以是一個程序的入口。

當然更具體詳細的講解,歡迎下載導師的教學PPT-Package來了解更多。


不過我在這裏想講的還是關於.h文件和.cpp文件

知道Package只是相對比較宏觀的理解:我們在項目中以Package爲編輯對象來擴展和修正我們的程序。編寫代碼時具體到應該把什麼放到.h文件,又該什麼放在.cpp文件中,我又迷惑了。

雖然Google給了我很多的鏈接,但是大部分的解釋都太籠統了:申明寫在.h文件,定義實現寫在.cpp文件。這個解釋沒有差錯,但是真正下手起來,又會發現不知道該把代碼往哪裏打。


於是我又把這個問題拋給了導師,他很耐心地給我詳詳細細地表述瞭如何在C++中進行代碼分離。很可惜,第一次我聽下了,但是沒有聽太懂,而且本來對C++就瞭解不深,所以也沒有深刻的印象。

經過幾個項目的試煉和體驗之後,我又拿出這個問題問導師,他又一次耐心地給我講解了一遍(我發誓他絕對不是忘記了我曾經問過同樣的問題),這次我把它記錄了下來。

爲了不再忘記,我將它們總結在這裏。

概覽

  非模板類型(none-template) 模板類型(template)
頭文件(.h)
  • 全局變量申明(帶extern限定符)
  • 全局函數的申明
  • inline限定符的全局函數的定義
  • 類的定義
  • 類函數成員和數據成員的申明(在類內部)
  • 類定義內的函數定義(相當於inline)
  • static const限定符的數據成員在類內部的初始化
  • inline限定符的類定義外的函數定義
  • 模板類的定義
  • 模板類成員的申明和定義(定義可以放在類內或者類外,類外不需要寫inline)
實現文件(.cpp)
  • 全局變量的定義(及初始化)
  • 全局函數的定義
(無)
  • 類函數成員的定義
  • 類帶static限定符的數據成員的初始化

*申明:declaration
*定義:definition

頭文件

頭文件的所有內容,都必須包含在

#ifndef {Filename} 
#define {Filename} 

//{Content of head file} 

#endif

這樣才能保證頭文件被多個其他文件引用(include)時,內部的數據不會被多次定義而造成錯誤

inline限定符

在頭文件中,可以對函數用inline限定符來告知編譯器,這段函數非常的簡單,可以直接嵌入到調用定義之處。

當然inline的函數並不一定會被編譯器作爲inline來實現,如果函數過於複雜,編譯器也會拒絕inline。

因此簡單說來,代碼最好短到只有3-5行的才作爲inline。有循環,分支,遞歸的函數都不要用做inline。

對於在類定義內定義實現的函數,編譯器自動當做有inline請求(也是不一定inline的)。因此在下邊,我把帶有inline限定符的函數成員和寫在類定義體內的函數成員統稱爲“要inline的函數成員”

非模板類型

全局類型

就像前面籠統的話講的:申明寫在.h文件。

對於函數來講,沒有實現體的函數,就相當於是申明;而對於數據類型(包括基本類型和自定義類型)來說,其申明就需要用extern來修飾。

然後在.cpp文件裏定義、實現或初始化這些全局函數和全局變量。

不過導師一直反覆強調:不許使用全局函數和全局變量。用了之後造成的後果,目前就是交上去的作業項目會扣分。當然不能用自有不能用的理由以及解決方案,不過不在目前的討論範圍內。


自定義類型

對於自定義類型,包括類(class)和結構體(struct),它們的定義都是放在.h文件中。其成員的申明和定義就比較複雜了,不過看上邊的表格,還是比較清晰的。

函數成員

函數成員無論是否帶有static限定符,其申明都放在.h文件的類定義內部。

對於要inline的函數成員其定義放在.h文件;其他函數的實現都放在.cpp文件中。

數據成員

數據成員的申明與定義都是放在.h文件的類定義內部。對於數據類型,關鍵問題是其初始化要放在什麼地方進行。

對於只含有static限定符的數據成員,它的初始化要放在.cpp文件中。因爲它是所有類對象共有的,因此必須對它做合適的初始化。

對於只含有const限定符的數據成員,它的初始化只能在構造函數的初始化列表中完成。因爲它是一經初始化就不能重新賦值,因此它也必須進行合適的初始化。

對於既含有static限定符,又含有const限定符的數據成員,它的初始化和定義同時進行。它也是必須進行合適的初始化

對於既沒有static限定符,又沒有const限定符的數據成員,它的值只針對本對象可以隨意修改,因此我們並不在意它的初始化什麼時候進行。


模板類型

C++中,模板是一把開發利器,它與C#,Java的泛型很相似,卻又不盡相同。以前,我一直只覺得像泛型,模板這種東西我可能一輩子也不可能需要使用到。但是在導師的強制逼迫使用下,我才真正體會到模板的強大,也真正知道要如何去使用模板,更進一步是如何去設計模板。不過這不是三言兩語可以講完的,就不多說了。

對於模板,最重要的一點,就是在定義它的時候,編譯器並不會對它進行編譯,因爲它沒有一個實體可用。

只有模板被具體化(specialization)之後(用在特定的類型上),編譯器纔會根據具體的類型對模板進行編譯。

所以才定義模板的時候,會發現編譯器基本不會報錯(我當時還很開心的:我寫代碼盡然會沒有錯誤,一氣呵成),也做不出智能提示。但是當它被具體用在一個類上之後,錯誤就會大片大片的出現,卻往往無法準確定位。

因此設計模板就有設計模板的一套思路和方式,但是這跟本文的主題也有偏。


因爲模板的這種特殊性,它並沒有自己的準確定義,因此我們不能把它放在.cpp文件中,而要把他們全部放在.h文件中進行書寫。這也是爲了在模板具體化的時候,能夠讓編譯器可以找到模板的所有定義在哪裏,以便真正的定義方法。

至於模板類函數成員的定義放在哪裏,導師的意見是放在類定義之外,因爲這樣當你看類的時候,一目瞭然地知道有那些方法和數據;我在用Visual Studio的時候查看到其標準庫的實現,都是放在類內部的。

可能是我習慣了C#的風格,我比較喜歡把它們都寫在類內部,也因爲在開發過程中,所使用的編輯器都有一個強大的功能:代碼摺疊。

當然還有其他原因就是寫在類外部,對於每一個函數成員的實現都需要把模板類型作爲限定符寫一遍,把類名限定符也要寫一遍。




來讓我們再看個簡單明瞭的


這個問題在許多C++程序員看來會很搞笑,“這麼簡單的問題還用得着你廢話!”。但是由於本人生性愚鈍,學C++的時候,確實花了很久的時間都搞不明白,只是會寫一個文件,但不會寫一個工程。而用C++編寫比較大型的項目時,文件的分割管理確實確實是非常必要的 。下面就非常簡潔明瞭地談談頭文件(.h)和源文件(.cpp)應該怎麼寫。

   頭文件(.h):
    寫類的聲明(包括類裏面的成員和方法的聲明)、函數原型、#define常數等,但一般來說不寫出具體的實現。

    在寫頭文件時需要注意,在開頭和結尾處必須按照如下樣式加上預編譯語句(如下):

#ifndef CIRCLE_H
#define CIRCLE_H

//你的代碼寫在這裏

#endif
    這樣做是爲了防止重複編譯,不這樣做就有可能出錯。

    至於CIRCLE_H這個名字實際上是無所謂的,你叫什麼都行,只要符合規範都行。原則上來說,非常建議把它寫成這種形式,因爲比較容易和頭文件的名字對應。

   源文件(.cpp):

    源文件主要寫實現頭文件中已經聲明的那些函數的具體代碼。需要注意的是,開頭必須#include一下實現的頭文件,以及要用到的頭文件。那麼當你需要用到自己寫的頭文件中的類時,只需要#include進來就行了。

    下面舉個最簡單的例子來描述一下,咱就求個圓面積。

     第1步,建立一個空工程(以在VS2003環境下爲例)。

     第2步,在頭文件的文件夾裏新建一個名爲Circle.h的頭文件,它的內容如下:

#ifndef CIRCLE_H
#define CIRCLE_H

class Circle
...{
private:
    double r;//半徑
public:
    Circle();//構造函數
    Circle(double R);//構造函數
    double Area();//求面積函數
};

#endif
   注意到開頭結尾的預編譯語句。在頭文件裏,並不寫出函數的具體實現。

    第3步,要給出Circle類的具體實現,因此,在源文件夾裏新建一個Circle.cpp的文件,它的內容如下:

#include "Circle.h"

Circle::Circle()
...{
    this->r=5.0;
}

Circle::Circle(double R)
...{
    this->r=R;
}

double Circle:: Area()
...{
    return 3.14*r*r;
}
    需要注意的是:開頭處包含了Circle.h,事實上,只要此cpp文件用到的文件,都要包含進來!這個文件的名字其實不一定要叫Circle.cpp,但非常建議cpp文件與頭文件相對應。

    最後,我們建一個main.cpp來測試我們寫的Circle類,它的內容如下:

#include <iostream>
#include "Circle.h"
using namespace std;

int main()
...{
    Circle c(3);
    cout<<"Area="<<c.Area()<<endl;
    return 1;
}
    注意到開頭時有#include "Circle.h"的聲明,證明我們使用到了我們剛纔寫的Circle類。

   至此,我們工程的結構爲:

 

    運行一下,輸出結果爲:

 

   說明我們寫的Circle類確實可以用了。

轉自此處
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章