如何在BASH中使用单行和多行注释

229 阅读4分钟

在任何脚本或代码中使用注释是非常重要的,可以使脚本更具有可读性。评论的作用是作为脚本的文档。如果作者对脚本进行了适当的注释,读者就可以很容易地理解脚本的每个步骤。脚本执行时,注释会被忽略。在bash脚本中可以非常容易地对单行进行注释。但是在bash脚本中对多行进行注释有多种方法。如何在bash脚本中使用单行和多行注释,将在本教程中展示。

单行注释

你可以通过在脚本的上方或侧面添加一个单行注释来解释每一行的功能。'#'符号用于在bash脚本中的单行注释。下面的例子显示了单行注释的使用。该脚本将计算两个整数的和,并打印出加法的值。在每个脚本行前都添加了单行命令,执行代码后将被忽略。

例1:单行注释

'#'符号用于在bash脚本中添加单行注释。用下面的代码创建一个bash脚本,检查在脚本中添加单行注释的方法。两个数字将被添加并在执行脚本后打印出来。在这里,所有的注释都被加在了脚本的每一行之前,以描述其目的。

#!/bin/bash
#Print a simple text
echo "Working with bash comments"
#Add 10 with 20 and store the value in n
((n=10+20))
#Print the value of n
echo $n

输出:
执行上述代码后会出现以下输出。

例2: bash脚本中的内联注释

单行注释也可以加在脚本的结尾处,这被称为内联注释。用下面的脚本创建一个bash文件来检查内联注释的使用情况。下面的脚本将合并两个字符串值,并打印合并后的值。在脚本中加入了四个内联注释,在执行时将被忽略。

#!/bin/bash

str1="Linux" # Initialize the first string value
str2=" Hint" # Initilaize the second string value

str=$str1$str2 # Combine the string values
echo "The string value after concatenating the strings"
echo $str # Print the combined string

输出:
执行上述代码后,将出现以下输出。

多行注释

在bash脚本中没有像其他编程语言那样的直接选项来对多行注释。你可以使用bash的其他功能来注释脚本中的多行。一个选项是使用'here document',另一个选项是使用':'。这两个选项的用法在下面的例子中显示。

例3:使用here document的多行注释

在注释的开头用<<符号定界,在注释的结尾也用同样的定界来在bash脚本中添加多行注释。用下面的脚本创建一个bash文件,以检查使用这里的文档添加多行注释的方法。在这里,LongComment 被用作here文档的分隔符来添加多行注释。脚本将计算并打印53的值作为输出。脚本中使用了一个多行注释和三个单行注释。

#!/bin/bash
<<LongComment
    This script is used to
    Calculate the cube of
    a number with value 5
LongComment
#Set the value of n
n=5
#Calculate 5 to the power 3
((result=$n*$n*$n))
#Print the area
echo $result

输出:
执行上述代码后会出现以下输出。

例4:使用':'命令的多行注释

使用冒号(:)和单引号是在bash脚本中添加多行注释的最简单方法。多行注释将被添加在冒号(:)之后的单引号(')中。多行注释的使用在下面的例子中有所体现。该脚本将检查一个数字是奇数还是偶数。这里,脚本中使用了一个多行注释来描述脚本的主要目的。

#!/bin/bash
#Initialize the variable n with a number
n=15
: '
The following script will check the number is
Even or odd by dividing the number by 2 and checking the remainder value
'
echo -n "$n "
if (( $n % 2 == 0 ))
then
      echo "is a even number."
else
      echo "is an odd number."
fi

输出:
执行上述代码后会出现以下输出。

例5:在Visual Studio代码中注释多行

在Visual Studio Code中使用'#'在多行中添加注释的方法已在本例中显示。前面例子中添加注释的方法可以应用于所有类型的编辑器。但如果你使用的是像Visual Studio Code这样的标准代码编辑器,注释多行或从多行中删除注释要比普通文本编辑器更容易。你必须在你的系统中安装这个编辑器来检查这个例子。使用Visual Studio代码编辑器创建一个bash文件,其脚本如下。

#!/bin/bash
echo "Working with bash comments"
((n=10+20))
echo $n

read -p "Enter the first number: " n1
read -p "Enter the second number: " n2
echo $((n1+n2))

选择你要注释的行,右击所选的行,从命令调色板中选择添加行注释

选择后,所选的行将被注释为'#',如下图所示。

选择你想取消注释的行,在所选行上点击右键,从命令调色板中选择删除区块注释,就可以从之前被注释的行中删除'#'。

总结

本教程通过多个例子展示了在bash脚本中添加单行和多行注释的不同方法。在bash中添加多行注释并不像其他编程语言在使用文本编辑器时那么简单。 本教程将帮助你学习和应用bash脚本中的单行和多行注释。