Linux脚本中注释用#开头,单行注释可置于行首或命令后;多行注释推荐每行加#,或用: '...'包裹;应注释关键逻辑、用途和注意事项,避免冗余、脱节或乱码。

Linux 脚本中使用注释,主要是为了说明代码功能、逻辑或提醒注意事项,让脚本更易读、易维护。Shell 脚本(如 Bash)用 # 开头的行表示注释,从 # 开始到行尾都会被解释器忽略。
单行注释写法
在任意一行开头或命令后添加 #,后面跟说明文字:
- # 这是一条完整行的注释
echo "Hello" # 输出问候语(这条注释紧接命令)- 注意:# 后必须有空格(虽然不强制,但这是通用规范,提升可读性)
多行注释的常用方式
Bash 本身没有原生多行注释语法,但可通过以下两种安全写法实现类似效果:
- 每行都加 #(推荐,清晰、兼容性强):
# 这是第一行说明
# 这是第二行说明
# 适合解释一段逻辑或参数用途 - 用
: ' ... '包裹(本质是执行一个空命令,引号内内容被当作字符串忽略):: '
这是一个跨多行的说明块
可以写使用前提、版本要求等'
注意:首尾的:和单引号必须严格匹配,且不能嵌套单引号
注释的实用位置和内容建议
好的注释不是越多越好,而是出现在关键节点,提供真正有价值的信息:
- 脚本开头写明用途、作者、创建时间、主要变量含义
- 复杂条件判断(if/else/case)前说明判断逻辑意图
- 调用外部命令时注明预期行为或常见失败原因,例如:
grep -q "pattern" file # 若匹配则返回 0,用于条件判断 - 临时禁用某段代码时,用注释包裹并说明原因,而非直接删除
避免的注释误区
注释应补充信息,而不是重复代码:
- ❌ 不要写:
name="Alice" # 将字符串 Alice 赋值给变量 name(显而易见) - ✅ 更好写:
name="Alice" # 默认用户名,供后续日志记录使用 - 避免注释与代码脱节(比如修改了命令却忘了更新注释)
- 不要用中文注释导致终端显示乱码——确保脚本文件编码为 UTF-8,并在 shebang 后加
# -*- coding: utf-8 -*-(部分编辑器支持,非必需但稳妥)


















