在 Bash 脚本中添加注释是保持代码整洁且易于理解的最有效方法之一。
你可能会问为什么。
假设你的脚本包含一个复杂的正则表达式或多个复杂的代码块,在这种情况下,你可以添加注释,以便其他开发人员或你可以了解该代码块的含义。
注释掉部分代码也有助于调试脚本。
在本教程中,我将引导你了解在 Bash 脚本中添加注释的三种方法:
- 单行注释
- 行内评论
- 多行注释
那么让我们从第一个开始。
Bash 中的单行注释
要添加单行注释,你必须将哈希符号(#
)放在行的开头并编写注释。
这是一个简单的例子:
#!/bin/bash
# This is a comment
echo "Hello, World!"
执行时,注释将被忽略,当我执行上面的命令时,它看起来像这样:
💡
#
注释规则的唯一例外是脚本开头的#!/bin/bash
行。它称为 释伴,用于指定运行脚本时要使用的解释器。有不同的 Shell,语法也可能不同。因此,一个好的做法是指定脚本是为哪个 Shell 编写的。例如,如果是 ksh,则可以使用#!/bin/ksh
.
Bash 脚本中的内联注释
或者,你可以将注释放在代码块内以记录该特定行的用途。
🚧
#
之后的任何内容在该行结束之前都不会执行,因此请确保在代码末尾添加注释。
这是一个简单的例子:
#!/bin/bash
echo "Hello, World!" #Prints hello world
Bash 中的多行注释
🚧 Bash 中没有内置的多行注释功能。但是,有一些解决方法可以实现多行注释效果。
顾名思义,Bash 脚本中的多行注释允许你在多行中编写注释,或者通过将它们放在多行注释部分来阻止执行代码块:
#