shell脚本注释方法

【1】单行注释

利用“#”对单行进行注释。

示例应用,新建文本,命名为test_single.sh 输入内容:

# 单行注释
echo '单行注释'
echo '123'
# echo '456'
echo '789'

执行结果:

【2】多行注释

(1)方式一

:<<!
# 注释内容块

示例应用,新建文本,命名为test_double_way1.sh 输入内容:

# 多行注释方式一
echo '多行注释方式一'
echo '456'
# echo '789'

:<<!
echo 'abc'
echo 'def'
echo 'hij'
!

echo '012'

执行结果:

(2)方式二

if false; then
# 注释内容块
fi

示例应用,新建文本,命名为test_double_way2.sh 输入内容:

# 多行注释方式二
echo '多行注释方式二'
echo '012'
# echo '345'

if false; then
echo 'abc'
echo 'def'
echo 'hij'
fi

echo '567'

执行结果:

(3)方式三

((0)) && {
# 注释内容块
}

示例应用,新建文本,命名为test_double_way3.sh 输入内容:

# 多行注释方式三
echo '多行注释方式三'
echo '678'
# echo '123'

((0)) && {
echo 'abc'
echo 'def'
echo 'hij'
}

echo '0123'

执行结果:

 

Good Good Study, Day Day Up.

顺序 选择  循环 总结

转载于:https://www.cnblogs.com/Braveliu/p/10855771.html

Shell 脚本中,**注释**是非常重要的,它可以帮助你和他人理解脚本的逻辑、用途以及注意事项。Shell 脚本使用 **`#` 符号** 来表示注释。 --- ## ✅ 一、单行注释 使用 `#` 开头的行即为注释行,Shell 不会执行它。 ```bash # 这是一个注释 echo "Hello World" # 这也是注释,位于命令后面 ``` ### 示例: ```bash #!/bin/bash # 输出欢迎信息 echo "欢迎使用 Shell 脚本!" # 显示当前日期 date ``` --- ## ✅ 二、多行注释(块注释Shell 本身 **不支持多行注释**,但可以通过以下方式实现“伪多行注释”: ### 方法一:每行加 `#` ```bash # 这是 # 多行 # 注释 ``` ### 方法二:使用 `: <<'COMMENT' ... COMMENT` 这是常用的“块注释”技巧,利用 Shell 的 `:`(空操作)命令和 Here Document 实现。 ```bash : <<'COMMENT' 这是多行注释 你可以写很多内容 这些内容不会被执行 COMMENT echo "脚本继续执行..." ``` > ⚠️ 注意:`COMMENT` 不能缩进,必须顶格写。 --- ## ✅ 三、Shebang 注释脚本解释器声明) 每个 Shell 脚本的首行通常以 `#!` 开头,称为 **Shebang**,它告诉系统用哪个解释器来运行脚本。 ```bash #!/bin/bash ``` 或者: ```bash #!/bin/sh ``` > ⚠️ Shebang 必须放在第一行,否则无效。 --- ## ✅ 四、函数注释(推荐写法) 虽然 Shell 没有专门的文档注释语法,但可以手动添加说明: ```bash # 函数名:greet # 功能:输出欢迎语 # 参数:$1 - 用户名 greet() { echo "你好, $1" } greet "张三" ``` --- ## ✅ 五、注释规范建议 | 用途 | 推荐写法 | |------|-----------| | 文件头说明 | `# 文件名: xxx.sh`<br>`# 功能: ...`<br>`# 作者: ...` | | 函数说明 | `# 函数名: func_name`<br>`# 参数: $1, $2...`<br>`# 功能: ...` | | 代码逻辑说明 | `# 如果文件存在,删除它`<br>`if [ -f file.txt ]; then rm file.txt; fi` | | 调试临时注释 | 使用 `#` 临时注释掉某行代码 | --- ## ✅ 六、示例:完整脚本注释 ```bash #!/bin/bash # 文件名: greet.sh # 功能: 输出欢迎信息 # 作者: John Doe # 日期: 2025-04-05 # 函数:greet # 参数:$1 - 用户名 greet() { echo "你好, $1" } # 主程序 greet "Alice" greet "Bob" # 结束提示 echo "欢迎信息已输出完毕" ``` --- ##
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值