#error – C++編譯預處理指令

在 C++ 語言中，預處理指令（preprocessor directive）是指以 “#” 開頭的一行代碼，用來告訴編譯器在編譯源代碼之前需要執行的特殊命令。其中一個非常重要的預處理指令就是 #error。

一、#error 的簡介

#error 指令用於在編譯時生成一個錯誤信息，中斷編譯過程。它的格式如下：

#error error-message

其中，error-message 是一個字元串，表示錯誤信息的內容。當編譯器處理到 #error 指令時，會停止編譯並顯示 error-message 的內容。這個功能對於調試代碼或者在某些條件下強制中斷編譯非常有用。

二、#error 的用法

1. 調試代碼

使用 #error 指令可以幫助我們在 Debug 的時候快速定位問題。在代碼中加入以下語句：

#ifdef DEBUG
#   define MY_ASSERT(x) ((x) ? (void)0 : \
                       std::cerr << "Assertion Failed: " \
                       << #x < 0);
    ...
}

上述代碼中，我們在調試模式下使用 MY_ASSERT 宏來檢查輸入參數，如果 a 不大於 0 就觸發 MY_ASSERT 宏里的錯誤。

當我們需要關閉 DEBUG 模式編譯代碼時，我們只需要把代碼中的 #define DEBUG 注釋掉即可。此時，如果我們忘記更改 MY_ASSERT 宏，編譯時就會觸發 #error 指令並顯示錯誤信息，讓我們及時發現和修復這個問題。

2. 強制中斷編譯

有時候我們需要強制停止編譯，例如當我們在編寫代碼時，為了遵循某些約定，需要限制代碼的長度或數量時，我們可以使用 #error 指令強制中斷編譯：

#if MAX_LENGTH > 1024
#error "the length of input string is too long!"
#endif

#if MAX_PARAS > 10
#error "the number of input parameters should not exceed 10."
#endif

void func(const char *str, const int paras[])
{
    ...
}

上面的代碼中，我們使用 #error 指令在編譯時檢查輸入參數的數量和長度是否合法。如果不合法，編譯過程會立即中斷並顯示錯誤信息，提醒我們檢查輸入。這樣可以避免別人或自己在調用這個函數時輸入無效的參數。

三、#error 的小結

在 C++ 編程中，#error 指令是一個非常有用的預處理指令，可以幫助我們調試代碼、中斷無效編譯，防止錯誤使用等。

以下是 #error 的完整代碼：

#ifdef DEBUG
#   define MY_ASSERT(x) ((x) ? (void)0 : \
                       std::cerr << "Assertion Failed: " \
                       << #x < 0);
    ...
}

#if MAX_LENGTH > 1024
#error "the length of input string is too long!"
#endif

#if MAX_PARAS > 10
#error "the number of input parameters should not exceed 10."
#endif

void func(const char *str, const int paras[])
{
    ...
}