# C++_空白鍵及註解
## 註解
在別人的程式碼中也許你經常看到註解，但你又是否知道該如何正確地使用註解
### 方式:
註解分為兩種註解，一種是**單行註解(Single-comment)**，第二種為**多行註解(multi-comment)**
#### 比較一下兩種註解的方式：
---
單行註解: **// (兩個斜線) 字元**，後面接著任何字元序列。

:::success
單行註解:
由雙斜線 " // " 開始，以換行符號結束，雙斜線右方的所有內容都會被compiler所忽略。
* 一個沒有前置反斜線的新行會終止這種形式的註解。 因此，它通常稱為「單行註解」。
:::
---
:::success
多行註解:
**/\* (斜線，星號) 字元**，後面接著任何字元序列 (包括新行)，後面接著 **\*/ 字元**。
* 多行註解以兩個界定符號 " /* " 和 " */ " 來規範，前者代表註解的開始，後者代表註解的結束，compiler會將兩個界定符中間的所有內容忽略。
:::
---
### 注意：註解不能以巢狀方式呈現，即不可在註解中又嵌入註解
:::warning 一個註解不能嵌入在另一個註解之內，compiler對這類問題所給出的錯誤信息可能是難以理解的。
例如下方的程式碼就會產生錯誤：

    /*
     *註解中不可將/* */嵌入
     *"嵌入"後面的字會被compiler誤認是source code
     *像剩餘程式碼一樣處理
     *從而導致錯誤
     */
    int main()
    {
      return 0;
    }

:::
>[!Note]補充:
>我們有時候在測試程式期間需要註解掉一些程式碼(comment out)，但是其中可能有些句子含有註解的界定符，因此最好的方式就是用單行註解來做comment out以避免這種情況，是一種工程師在書寫C++程式時需要培養的好習慣。
例如:

    // /*
    //  *單行註解中的任何內容都會被忽略
    //  *包刮巢狀結構的註釋也會一樣被忽略
    //  */

### 用途：
* 解釋程式碼: 用自然語言解釋程式碼的功能、邏輯或特定的算法。
* 標記代碼段: 用來標記程式碼中的重要部分，例如函數的開始和結束、類的定義等。
* 暫時禁用程式碼: 可以使用註解將一段程式碼暫時註釋掉，以便進行測試或調試。
#### 重要性：
* 可讀性: 註解可以幫助開發人員和其他人更好地理解程式碼的意圖。
* 維護性: 當程式碼經過長時間的修改後，註解可以幫助開發人員快速回憶起程式碼的原始設計。
* 協作: 註解可以促進團隊成員之間的交流和協作。
---
## 空白鍵
...沒什麼好說的
### 用途：
* 分隔符: 在變數、運算子、關鍵字之間加入空格，可以讓程式碼更**易於閱讀**，提升可讀性。
* 縮排: 利用空格或 Tab 鍵進行縮排，可以**清楚地表示程式碼的層級關係**，尤其是對於程式區塊或迴圈等。
#### 重要性:
* 可讀性: 合理使用空格可以讓程式碼看起來更整潔、**美觀(這是身為強迫症的堅持)**，減少閱讀時的負擔。
* 維護性: 當程式碼需要修改或擴展時，清晰的格式可以幫助開發人員快速定位問題並進行修改。
* 協作: 在團隊開發中，統一的程式碼風格可以提高團隊合作效率。