如何在 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 行被解释器视为多行注释。

comments powered by Disqus