C++ #pragma once指令：保護C++頭文件不被重複包含

一、#ifndef/#define/#endif指令的問題

在C++中，頭文件的作用就是將代碼以模塊的形式組織起來，便於復用和維護。但是，頭文件很容易出現重複定義的問題。比如，某個頭文件被多個源文件包含，這些源文件又有可能被其他源文件包含，那麼就有可能出現一個頭文件被重複包含的情況。這樣就會導致編譯器生成的目標文件中出現多個相同的目標代碼，最終鏈接器又要處理這些相同的目標代碼，浪費時間和空間。

為了避免這個問題，C++程序員們想到了用宏來實現頭文件保護。一般的做法是在頭文件中加入下面3行代碼：

#ifndef _XXX_H_
#define _XXX_H_
// 此處是頭文件的內容
#endif // _XXX_H_

其中，_XXX_H_是頭文件的宏名，可以隨便指定，只要不和其他宏名重複即可。這幾行代碼的意思是：

• 如果沒有定義過宏名 _XXX_H_，則定義它，並編譯頭文件的內容
• 如果已經定義過，則跳過頭文件的內容，避免重複編譯

但是，這種寫法還是有一個問題，就是它依賴於宏的唯一性。如果程序中有多個宏名相同的頭文件，那麼就會出現重複編譯的問題，鏈接器又要處理多個相同的目標代碼。所以，在實際開發中，程序員們更傾向於使用 #pragma once 指令來解決頭文件保護的問題。

二、#pragma once指令的作用

#pragma once 是一種編譯器指令，它可以確保同一個頭文件不會被重複包含。這個指令的原理很簡單，就是在頭文件的開頭加上一行代碼 #pragma once 即可。編譯器在遇到這個指令時，會先檢查這個頭文件是否已經被包含過，如果已經包含過，則直接跳過；否則，編譯頭文件的內容並標記為已包含。

示例代碼：

#pragma once  // 這個頭文件只會被編譯一次

#include <iostream>

void foo()
{
  std::cout << "Hello, world!" << std::endl;
}

三、#pragma once指令的優勢

通過以上分析，我們可以發現，使用 #pragma once 指令有如下的優勢：

• 編譯速度更快：相比 #ifndef/#define/#endif 指令，編譯器只需要檢查一次，就能確定是否已經包含了這個頭文件。這樣，就節省了大量的編譯時間。
• 寫法更簡潔：只需要在頭文件的開頭加上一行代碼即可，省去了寫宏名的繁瑣過程，代碼也更加簡潔。
• 可讀性更好：相比較於 #ifndef/#define/#endif 指令， #pragma once 指令的可讀性更好，在代碼的可讀性方面有着更好的體現。

四、#ifndef/#define/#endif與#pragma once的比較

那麼，在實際開發中應該使用哪種頭文件保護方式呢？下面是兩種方式的對比：

五、總結

使用頭文件可以將程序模塊化，方便代碼的復用和維護。在C++中，頭文件保護是一項重要的任務，可以避免頭文件被重複包含而導致的編譯錯誤和鏈接器錯誤。對於“#ifndef/#define/#endif”和“#pragma once”兩種保護方式，我們必須根據實際情況選擇最適合自己項目的方式。

示例代碼：

// foo.h
#pragma once

void foo();

// foo.cpp
#include "foo.h"

void foo()
{
  std::cout << "Hello, world!" << std::endl;
}

// main.cpp
#include "foo.h"

int main()
{
  foo();
  return 0;
}