bash 脚本风格指南：编写规范代码140

作为一名软件工程师，编写可维护、清晰且高效的代码至关重要。对于 bash 脚本编写而言，遵循特定的风格指南可确保代码的可读性、一致性和可重用性。

缩进

一致的缩进有助于提高代码的可读性。建议使用 2 个空格或 1 个制表符进行缩进，并且在块级语句中始终保持一致的缩进级别。```bash
# 正确：
if [ "$condition" = "true" ]; then
echo "条件为真"
else
echo "条件为假"
fi
# 错误：
if [ "$condition" = "true" ] ; then
echo "条件为真"
else
echo "条件为假"
fi
```

注释

清晰且全面的注释对于理解脚本的行为至关重要。建议使用适当的语法并提供有价值的信息，例如目的、实现方式和任何潜在限制。```bash
# 正确：
# 这是一条注释，解释了此代码块的用途
my_function() {
# 具体实现
}
# 错误：
# 没有注释，不清楚此代码块的用途
my_function() {
# 实现
}
```

变量命名

变量名称应清晰、简洁并能反映其用途。建议使用小写字母和下划线来分隔单词，并避免使用特殊字符或数字作为名称开头。```bash
# 正确：
my_variable=123 # 整数变量
text_to_display="Hello world" # 字符串变量
# 错误：
var1=123 # 变量名称太笼统
123_var="Hello world" # 变量名称以数字开头
```

函数定义

函数应声明为关键字 `function` 后跟函数名称，后跟括号中参数列表。函数体应以缩进开始，并在末尾以 `fi` 结束。```bash
# 正确：
function my_function() {
# 函数体
}
# 错误：
my_function() {
# 函数体
fi
```

条件语句

条件语句应使用 `if`、`elif` 和 `else` 关键字编写，括号中包含条件表达式。条件应使用中括号表示，并且每个语句应始终以分号结尾。```bash
# 正确：
if [ "$condition" = "true" ]; then
echo "条件为真"
elif [ "$condition" = "false" ]; then
echo "条件为假"
else
echo "未知条件"
fi
# 错误：
if [ "$condition" = "true" ] then
echo "条件为真"
else
echo "条件为假"
fi
```

循环语句

循环语句应使用 `for`、`while` 或 `until` 关键字编写，括号中包含循环条件。循环体应以缩进开始，并在末尾以 `done` 结束。```bash
# 正确：
for i in 1 2 3; do
echo "数字是 $i"
done
# 错误：
for i in 1 2 3
do
echo "数字是 $i"
done
```

文件 I/O

文件 I/O 操作应使用 `cat`、`echo`、`grep`、`sed` 和 `awk` 等命令执行。这些命令应使用适当的选项和参数来操作文件的内容。```bash
# 正确：
cat # 显示文件内容
echo "Hello world" > # 写入文件
grep "pattern" # 查找模式
sed 's/old/new/g' # 替换字符串
# 错误：
> "Hello world" # 错误的重定向语法
find "pattern" # 错误的命令
```

错误处理

错误处理应使用 `set -e` 选项启用，该选项导致脚本在遇到第一个错误时退出。建议使用 `trap` 命令捕捉特定错误并执行适当的处理程序。```bash
# 正确：
set -e # 启用错误处理
trap 'echo "错误已捕获"' ERR # 捕获错误并执行处理程序
# 错误：
trap 'echo "错误已捕获"' ERR # 捕获错误
set -e # 启用错误处理
```

其他建议* 保持脚本简洁明了
* 优化性能并避免不必要的系统调用
* 使用 shebang 行指定脚本解释器
* 对脚本进行单元测试以验证其行为
* 使用版本控制系统管理脚本更改

2024-12-09

上一篇：如何查看 Ubuntu 中的 Bash 脚本

下一篇：Docker 运行 Bash 脚本：深入指南