| 在腳本或代碼中使用注釋對于使腳本更具可讀性非常重要。注釋作為腳本的文檔。如果作者正确注釋腳本，讀者可以輕松了解腳本的每個步驟。腳本執行時會忽略注釋。可以很容易地在 Bash 腳本中對單行進行注釋。但是有多種方法可以對 Bash 腳本中的多行進行注釋。本教程展示了如何在 Bash 腳本中使用單行和多行注釋。 |
單行注釋：
您可以通過在行的上面或側面添加單行注釋來解釋腳本的每一行的功能。' # ' 符号用于對 Bash 腳本中的單行進行注釋。以下示例顯示了單行注釋的使用。該腳本将計算兩個整數的和，并列印加法的值。在執行代碼後将被忽略的每個腳本行之前添加了單行指令。
示例 1：單行注釋
'#' 符号用于在 Bash 腳本中添加單行注釋。使用以下代碼建立一個 Bash 腳本，以檢查在腳本中添加單行注釋的方式。執行腳本後将添加并列印兩個數字。在這裡，所有注釋都已添加到腳本的每一行之前，以描述其用途。
#!/bin/bash
#列印簡單文本
echo "使用 bash 注釋"
#将20與30相加，并将值存儲在n中
((n=20+30))
#列印n的值
echo $n 輸出：
執行上述代碼後會出現如下輸出。
示例 2：bash 腳本中的内聯注釋
單行注釋也可以添加在稱為内聯注釋的腳本末尾之後。使用以下腳本建立一個 bash 檔案來檢查内聯注釋的使用。以下腳本将組合兩個字元串值并列印組合值。腳本中添加了四個内聯注釋，在執行時将被忽略。
#!/bin/bash
str1="Linux迷" # 初始化第1個字元串值
str2=" Linux" # 初始化第2個字元串值
str3="Mi.com" # 初始化3個字元串值
str=$str1$str2$str3 # 組合字元串值
echo "串接字元串後的字元串值"
echo $str # 列印組合字元串 輸出：
執行上述代碼後會出現如下輸出。
多行注釋：
沒有像其他程式設計語言那樣對 bash 腳本中的多行進行注釋的直接選項。您可以使用 bash 的其他功能來注釋腳本中的多行。一種選擇是使用' here document '，另一種選擇是使用':'。以下示例顯示了這兩個選項的用法。
示例 3：使用此處文檔的多行注釋
在帶有 << 符号的注釋開頭使用分隔符，在注釋末尾使用相同的分隔符在 bash 腳本中添加多行注釋。使用以下腳本建立一個 bash 檔案，以檢查使用here document 添加多行注釋的方式。在這裡，LongComment已被用作here document 的分隔符，以添加多行注釋。該腳本将計算并列印 5 的 3 次方的值作為輸出。腳本中使用了一個多行注釋和三個單行注釋。
#!/bin/bash
<<LongComment
此腳本用于
計算
值為5的數的立方
LongComment
#設定n的值
n=5
#計算5的3次方
((result=$n*$n*$n))
#列印區域
echo $result 輸出：
執行上述代碼後會出現如下輸出。
示例 4：使用 ':' 指令的多行注釋
使用帶單引号的冒号 (:) 是在 bash 腳本中添加多行注釋的最簡單方法。多行注釋将添加在冒号(:) 之後的單引号(') 内。多行注釋的使用如下例所示。該腳本将檢查一個數字是奇數還是偶數。在這裡，腳本中使用了一個多行注釋來描述腳本的主要目的。
#!/bin/bash
#用數字初始化變量n
n=19
: '
以下腳本
通過将數字除以2并檢查餘數值來實作結果為偶數還是奇數
'
echo -n "$n "
if (( $n % 2 == 0 ))
then
echo "是一個偶數。"
else
echo "是一個奇數。"
fi 輸出：
執行上述代碼後會出現如下輸出。
示例 5：在 Visual Studio Code 中注釋多行
此示例顯示了在 Visual Studio Code 中使用“#”一次在多行中添加注釋的方法。前面示例中添加注釋的方式可以适用于所有類型的編輯器。但是，如果您使用任何标準代碼編輯器（如 Visual Studio Code），則注釋多行或從多行中删除注釋比普通文本編輯器更容易。您必須在系統中安裝此編輯器才能檢查此示例。使用 Visual Studio Code 編輯器使用以下腳本建立一個 bash 檔案。
#!/bin/bash
echo "使用 bash 注釋"
((n=20+30))
echo $n
read -p "輸入第一個數字: " n1
read -p "輸入第二個數字: " n2
echo $((n1+n2)) 選擇要注釋掉的行，右鍵單擊標明的行，然後從指令面闆中選擇添加行注釋 Add line comment。
選擇後，選中的行将被注釋為“#”，如下圖所示。
選擇要取消注釋的行并右鍵單擊標明的行，然後從指令面闆中選擇“删除行注釋 Remove line comment”以從之前注釋的行中删除“#”。