如何在 Bash 指令碼中使用單行和多行註釋

導讀	在 或程式碼中使用註釋對於使 更具可讀性非常重要。註釋作為指令碼的文件。如果作者正確註釋指令碼，讀者可以輕鬆理解指令碼的每個步驟。指令碼執行時會忽略註釋。可以很容易地在 Bash 指令碼中對單行進行註釋。但是有多種方法可以對 Bash 指令碼中的多行進行註釋。本教程展示瞭如何在 Bash 指令碼中使用單行和多行註釋。

您可以透過在行的上面或側面新增單行註釋來解釋指令碼的每一行的功能。' # ' 符號用於對 Bash 指令碼中的單行進行註釋。以下示例顯示了單行註釋的使用。該指令碼將計算兩個整數的和，並列印加法的值。在執行程式碼後將被忽略的每個指令碼行之前新增了單行 。

'#' 符號用於在 Bash 指令碼中新增單行註釋。使用以下程式碼建立一個 Bash 指令碼，以檢查在指令碼中新增單行註釋的方式。執行指令碼後將新增並列印兩個數字。在這裡，所有註釋都已新增到指令碼的每一行之前，以描述其用途。

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

輸出：

執行上述程式碼後會出現如下輸出。

單行註釋也可以新增在稱為內聯註釋的指令碼末尾之後。使用以下指令碼建立一個 bash 檔案來檢查內聯註釋的使用。以下指令碼將組合兩個字串值並列印組合值。指令碼中新增了四個內聯註釋，在執行時將被忽略。

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

輸出：

執行上述程式碼後會出現如下輸出。

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

在帶有 << 符號的註釋開頭使用分隔符，在註釋末尾使用相同的分隔符在 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

輸出：

執行上述程式碼後會出現如下輸出。

使用帶單引號的冒號 (:) 是在 bash 指令碼中新增多行註釋的最簡單方法。多行註釋將新增在冒號(:) 之後的單引號(') 內。多行註釋的使用如下例所示。該指令碼將檢查一個數字是奇數還是偶數。在這裡，指令碼中使用了一個多行註釋來描述指令碼的主要目的。

#!/bin/bash
#用數字初始化變數n
n=19
: '
以下指令碼
透過將數字除以2並檢查餘數值來實現結果為偶數還是奇數
'
echo -n "$n "
if (( $n % 2 == 0 ))
then
echo "是一個偶數。"
else
echo "是一個奇數。"
fi

輸出：

執行上述程式碼後會出現如下輸出。

此示例顯示了在 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”以從之前註釋的行中刪除“#”。

本教程透過多個示例展示了在 bash 指令碼中新增單行和多行註釋的不同方法。使用文字編輯器時，在 bash 中新增多行註釋並不像其他程式語言那樣簡單。本教程將幫助您學習和在 bash 指令碼中應用單行和多行註釋。

原文來自：