在腳本或代碼中使用注釋對于使腳本更具可讀性非常重要。注釋作為腳本的文檔。如果作者正確注釋腳本，讀者可以輕松理解腳本的每個步驟。腳本執(zhí)行時會忽略注釋。可以很容易地在 Bash 腳本中對單行進行注釋。但是有多種方法可以對 Bash 腳本中的多行進行注釋。本教程展示了如何在 Bash 腳本中使用單行和多行注釋。

單行注釋：

您可以通過在行的上面或側(cè)面添加單行注釋來解釋腳本的每一行的功能。' # ' 符號用于對 Bash 腳本中的單行進行注釋。以下示例顯示了單行注釋的使用。該腳本將計算兩個整數(shù)的和，并打印加法的值。在執(zhí)行代碼后將被忽略的每個腳本行之前添加了單行命令。

示例 1：單行注釋

'#' 符號用于在 Bash 腳本中添加單行注釋。使用以下代碼創(chuàng)建一個 Bash 腳本，以檢查在腳本中添加單行注釋的方式。執(zhí)行腳本后將添加并打印兩個數(shù)字。在這里，所有注釋都已添加到腳本的每一行之前，以描述其用途。

#!/bin/bash
#打印簡單文本
echo "使用 bash 注釋"
#將20與30相加，并將值存儲在n中
((n=20+30))
#打印n的值
echo $n

輸出：

執(zhí)行上述代碼后會出現(xiàn)如下輸出。

示例 2：bash 腳本中的內(nèi)聯(lián)注釋

單行注釋也可以添加在稱為內(nèi)聯(lián)注釋的腳本末尾之后。使用以下腳本創(chuàng)建一個 bash 文件來檢查內(nèi)聯(lián)注釋的使用。以下腳本將組合兩個字符串值并打印組合值。腳本中添加了四個內(nèi)聯(lián)注釋，在執(zhí)行時將被忽略。

#!/bin/bash
str1="Linux迷" # 初始化第1個字符串值
str2=" Linux" # 初始化第2個字符串值
str3="Mi.com" # 初始化3個字符串值
str=$str1$str2$str3 # 組合字符串值
echo "串接字符串后的字符串值"
echo $str # 打印組合字符串

輸出：

執(zhí)行上述代碼后會出現(xiàn)如下輸出。

串接字符串后的字符串值
Linux迷 LinuxMi.com

多行注釋：

沒有像其他編程語言那樣對 bash 腳本中的多行進行注釋的直接選項。您可以使用 bash 的其他功能來注釋腳本中的多行。一種選擇是使用' here document '，另一種選擇是使用':'。以下示例顯示了這兩個選項的用法。

示例 3：使用此處文檔的多行注釋

在帶有 << 符號的注釋開頭使用分隔符，在注釋末尾使用相同的分隔符在 bash 腳本中添加多行注釋。使用以下腳本創(chuàng)建一個 bash 文件，以檢查使用here document 添加多行注釋的方式。在這里，LongComment已被用作here document 的分隔符，以添加多行注釋。該腳本將計算并打印 5 的 3 次方的值作為輸出。腳本中使用了一個多行注釋和三個單行注釋。

#!/bin/bash
<<LongComment
   此腳本用于
   計算
   值為5的數(shù)的立方
LongComment
#設置n的值
n=5
#計算5的3次方
((result=$n*$n*$n))
#打印區(qū)域
echo $result

輸出：

執(zhí)行上述代碼后會出現(xiàn)如下輸出。

示例 4：使用 ':' 命令的多行注釋

使用帶單引號的冒號 (:) 是在 bash 腳本中添加多行注釋的最簡單方法。多行注釋將添加在冒號(:) 之后的單引號(') 內(nèi)。多行注釋的使用如下例所示。該腳本將檢查一個數(shù)字是奇數(shù)還是偶數(shù)。在這里，腳本中使用了一個多行注釋來描述腳本的主要目的。

#!/bin/bash
#用數(shù)字初始化變量n
n=19
: '
以下腳本
通過將數(shù)字除以2并檢查余數(shù)值來實現(xiàn)結(jié)果為偶數(shù)還是奇數(shù)
'
echo -n "$n "
if (( $n % 2 == 0 ))
then
     echo "是一個偶數(shù)。"
else
     echo "是一個奇數(shù)。"
fi

輸出：

執(zhí)行上述代碼后會出現(xiàn)如下輸出。

示例 5：在 Visual Studio Code 中注釋多行

此示例顯示了在 Visual Studio Code 中使用“#”一次在多行中添加注釋的方法。前面示例中添加注釋的方式可以適用于所有類型的編輯器。但是，如果您使用任何標準代碼編輯器（如 Visual Studio Code），則注釋多行或從多行中刪除注釋比普通文本編輯器更容易。您必須在系統(tǒng)中安裝此編輯器才能檢查此示例。使用 Visual Studio Code 編輯器使用以下腳本創(chuàng)建一個 bash 文件。

#!/bin/bash
echo "使用 bash 注釋"
((n=20+30))
echo $n
read -p "輸入第一個數(shù)字: " n1
read -p "輸入第二個數(shù)字: " n2
echo $((n1+n2))

選擇要注釋掉的行，右鍵單擊選定的行，然后從命令面板中選擇添加行注釋 Add line comment。

選擇后，選中的行將被注釋為“#”，如下圖所示。

選擇要取消注釋的行并右鍵單擊選定的行，然后從命令面板中選擇“刪除行注釋 Remove line comment”以從之前注釋的行中刪除“#”。

結(jié)論：

本教程通過多個示例展示了在 bash 腳本中添加單行和多行注釋的不同方法。使用文本編輯器時，在 bash 中添加多行注釋并不像其他編程語言那樣簡單。本教程將幫助您學習和在 bash 腳本中應用單行和多行注釋。