在 bash 脚本中使用注释

在编写 Bash 脚本时，始终使代码干净且易于理解是一个好习惯。以块形式组织代码，缩进，为变量和函数提供描述性名称是实现此目的的几种方法。

提高代码可读性的另一种方法是使用注释。注释是在 shell 脚本中编写的易于理解的解释或说明。

在将来查看代码时，向 Bash 脚本添加注释将节省大量时间和精力。假设您要更改几个月或几年前编写的脚本。除非您添加注释，否则您将不记得为什么编写了一些复杂的代码。

这些注释还可以帮助到以后可能要需要维护脚本以了解您的代码及其用途的其他开发人员和系统管理员。

注释通常用于解释复杂的代码的操作逻辑。例如，如果您的 Bash 脚本中有复杂的正则表达式或参数替换，则应编写有关代码功能的注释。评论应该简短明了。不要解释一些简单易懂的内容。

在本文中，我们将介绍如何在 Bash 中使用注释。

在 Bash 使用注释

Bash 忽略该行上井号 (#) 之后写入的所有内容。该规则的唯一例外是脚本的第一行以 #! 字符开头。此字符序列称为 Shebang ，用于告诉操作系统使用哪个解释器来解析文件的其余部分。

注释可以添加到行的开头或与其他代码内联：

# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.

井号后面的空格不是强制性的，但是它将提高注释的可读性。

通常，在文本编辑器中打开脚本时，注释以绿色表示。

测试脚本时，注释也很有用。除了删除一些行或块，您还可以将它们注释掉：

# if [[ $VAR -gt 10 ]]; then
#  echo "Variable is greater than 10."
# fi

Bash 中的多行注释

与大多数编程语言不同， Bash 不支持多行注释。

在 Bash 中编写多行注释的最简单方法是一个接一个地添加单个注释：

# This is the first line.
# This is the second line.

另一种选择是使用 HereDoc 。这是一种重定向类型，它允许您将多行输入传递给命令。如果 HereDoc 块未重定向到命令，则可以用作多行注释占位符：

<< 'MULTILINE-COMMENT'
    Everything inside the
    HereDoc body is
    a multiline comment
MULTILINE-COMMENT

使用 HereDoc 是一种技巧，而不是真正的内置方式来编写多行 Bash 注释。为了避免出现任何问题，您应该首选使用单行注释。

结论

编写注释是一种好习惯，并且可以帮助其他开发人员(包括将来的自己)理解 Shell 脚本。在 Bash 中，井号 (#) 之后直至行尾的所有内容均视为注释。