在本小节中，我们将了解如何在Bash脚本文件中插入注释。

注释是任何编程语言的必要组成部分。它们用于定义或说明代码或功能的用法。注释是有助于程序可读性的字符串。当在Bash脚本文件中执行命令时，它们不会执行。

Bash脚本提供了对两种类型注释的支持，就像其他编程语言一样。

• 单行注释
• 多行注释

Bash单行注释

要在bash中编写单行注释，必须在注释的开头使用井号(#)。以下是Bash脚本的示例，该示例在命令之间包含单行注释：

Bash脚本

#!/bin/bash  

#This is a single-line comment in Bash Script.  
echo "Enter your name:"  
read name  
echo  
#echo output, its also a single line comment  
echo "The current user name is "$name""  
#This is another single line comment

将上面代码保存到一个文件：single-line-bash.sh，执行后得到以下结果：

maxsu@ubuntu:~$ chmod +x single-line-bash.sh 
maxsu@ubuntu:~$ ./single-line-bash.sh 
./single-line-bash.sh: line 1: i: command not found
Enter your name:
maxsu

The current user name is "maxsu"

在此可以清楚地看到，在执行命令的过程中忽略了注释，注释的内容并被解释输出。

Bash多行注释

有两种方法可以在bash脚本中插入多行注释：

• 通过在<< COMMENT和COMMENT之间加上注释，可以在bash脚本中编写多行注释。
• 也可以通过将注释括在(:')和单引号(')之间来编写多行注释。

阅读以下示例，这些示例将帮助您理解多行注释的这两种方式：

多行注释-方法1

#!/bin/bash  

<<BLOCK 
    This is the first comment  
    This is the second comment  
    This is the third comment  
BLOCK

echo "Hello World"

将上面代码保存到一个文件：mulines-bash1.sh，执行后得到以下结果：

maxsu@ubuntu:~/bashcode$ vi mulines-bash1.sh 
maxsu@ubuntu:~/bashcode$ ./mulines-bash1.sh 
Hello World
maxsu@ubuntu:~/bashcode$

多行注释-方法2

#!/bin/bash  

: '  
This is the first comment  
This is the second comment  
This is the third comment  
'  

echo "Hello World"

将上面代码保存到一个文件：mulines-bash2.sh，执行后得到以下结果：

maxsu@ubuntu:~/bashcode$ chmod +x  mulines-bash2.sh 
maxsu@ubuntu:~/bashcode$ ./mulines-bash2.sh 
Hello World

在本小节中，我们讨论了如何在Bash脚本文件中插入单行和多行注释。