你的同事对你“刮目相看”的原因可能是因为你遵循了以下 shell 脚本编写规范和技巧:
指定解释器和执行权限:
使用 shebang 方式明确指定脚本解释器。确保脚本文件具有执行权限,方便直接运行。
清晰注释:
代码中包含详细注释,解释功能并提醒注意事项。注释有助于他人理解和维护脚本。
规范参数处理:
明确定义变量:
避免硬编码“魔数”,提高代码可维护性。合理使用环境变量。
合理使用缩进和命名:
使用清晰的缩进区分代码块,增强可读性。命名遵循标准,便于理解和查找。
编码和日志:
统一编码为 UTF8,注意跨平台兼容性。使用英文注释和日志,提高国际化水平。使用 log 记录执行过程,提升用户反馈体验。
安全性:
长命令处理:
变量引用:
使用 $ 获取变量时,推荐加上双引号,避免字符串解析错误。
结构化脚本:
利用 main 函数结构化脚本,增强代码可读性和逻辑清晰度。
作用域管理:
合理使用 local 和 readonly 等命令管理变量作用域。
函数返回值:
函数返回值仅限整数,若需传递其他类型信息,使用变通方法。
间接引用变量:
使用变量名前加“!”实现简单引用,避免使用 eval。
多行输入:
善用 heredocs 提供多行输入方式,方便生成模板文件。
获取脚本路径:
使用 cd 到脚本目录后再使用 pwd 获取脚本路径,避免混淆。
代码简洁和效率:
文本检索和静态检查:
注意文件名包含空格的处理和文件字符集的一致性问题。引入静态检查工具如 shellcheck,提升脚本质量,并通过 CI 系统集成进行自动化检查。
通过遵循这些规范和技巧,你的 shell 脚本不仅易于理解和维护,还具备较高的安全性和执行效率,因此得到了同事的认可和赞赏。