如何在 Bash 指令碼中新增註釋

1. Bash 中的單行註釋
2. Bash 中的多行註釋

註釋是被直譯器忽略的行，只是用來描述程式碼中發生的事情，或者對特定的程式碼塊或程式碼行進行深入的瞭解。註釋讓讀程式碼的人更容易理解程式碼。我們可以使用註釋用人類的語言來描述程式碼中發生的事情。當我們在寫了一段時間的程式碼後，回顧我們的程式碼時，它也會很有幫助。在除錯程式碼的時候，註釋也很有用。我們可以不刪除被懷疑有 bug 的部分，而是將特定的部分註釋出來，然後除錯程式碼。

我們可以在 Bash 中使用 # 和 heredoc 來寫註釋。一般來說，# 用來寫單行註釋，heredoc 用來寫多行註釋。

Bash 中的單行註釋

我們使用 # 符號在 Bash 中編寫單行命令。在 # 之後，除了第一行包含 #!之外，在解釋指令碼時，所有的東西都被忽略。第一行出現的這個特定序列 #! 稱為 Shebang，它用來決定使用哪個直譯器。

註釋可以從行首開始，甚至可以與程式碼內聯。

#!/bin/bash
echo "Hello World!" # echo is similar to print statement.
# end of the code

輸出：

Hello World!

這裡，第一行表明要使用的編譯器是/bin/bash。

在第二行，我們有內聯註釋，在第三行，我們有一個從行開始的註釋。

Bash 中的多行註釋

Bash 不支援多行註釋。在 Bash 中寫多行註釋的一種方法是對每行使用單行註釋。

# This is a
# multiline comment in Bash
echo "Hello World!"

輸出：

Hello World!

在這裡，第 1 行和第 2 行可以被認為是多行註釋，每一行都被直譯器解釋為一個單獨的註釋。

我們還可以利用 Heredoc 來編寫多行命令。Heredoc 是一種向命令傳遞多行輸入的方法。如果 Heredoc 沒有重定向到任何命令，我們可以將 Heredoc 作為多行註釋使用。

#!/bin/bash

<< 'Comment'
    Everything inside the
    HereDoc body is
    a multiline comment
Comment
echo "Hello World!" 

輸出：

Hello World!

這裡，3-7 行被直譯器視為多行註釋。