在编写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注释。
为了避免出现任何问题，我们应该更喜欢使用单行注释。