如何在bash脚本添加注释

在编写 Bash 脚本时，使代码干净且易于理解始终是一个好习惯。以块的形式组织代码、缩进、为变量和函数提供描述性名称是执行此操作的几种方法, 另一种提高代码可读性的方法是使用注释。注释是写在 shell 脚本中的人类可读的解释或注释。

在您的 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 中编写多行注释的最简单方法是一个接一个地添加单个注释：

# 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 是一种 hack，而不是真正的内置方式来编写多行 Bash 注释。为避免任何问题，您应该更喜欢使用单行注释。

总结

写注释是一种很好的做法，它可以帮助其他开发人员，包括未来的自己，理解 shell 脚本。在 Bash 中，井号 ( #) 之后直到行尾的所有内容都被视为注释。