在Bash/KSH Shell脚本如何添加多行注释

时间:2019-11-20 08:52:58  来源:igfitidea点击:

shell脚本中多行注释如何写?

默认情况下,shell脚本使用#字符进行注释,例如:

# 这里是注释

在Bash Shell脚本添加多行注释语法

对于多行注释,请使用以下语法:

#!/usr/bin/env bash
# 注释 1
# 注释 2
# 注释 N

还可以使用HERE DOCUMENT功能:

#!/bin/bash
echo "Say Something"
<<HERE
    your comment 1
    comment 2
    blah
HERE
echo "Do something else"

此类重定向告诉shell从当前源(HERE)读取输入,直到看到仅包含单词(HERE)的行。
这里的单词不受变量名,参数扩展,算术扩展,路径名扩展或命令替换的约束。

以这种方式处理文件通常在这里称为文档。

Bash注释块示例

将EOF放在单引号('EOF')中,可以避免命令执行。

例如:

#!/usr/bin/env bash
echo "*** 注释前的代码 ***"
<<'EOF'
注释块语句1
注释块语句2
EOF
echo "*** 注释后的代码 ***"

shell脚本中使用空命令进行注释

#!/bin/bash
foo=bar
: '
注释语句1
注释语句2
'
 
echo "Init..."
# rest of script

是shell内置命令。

它的参数无作用;该命令除了扩展参数和执行任何指定的重定向外,什么也不做。返回零退出代码。

因此语法为:

: '
这里写注释
'

Shell脚本中使用的Null命令用于放置多行注释。 ":"没有作用。换句话说,该命令不执行任何操作,并且始终返回成功状态后退出。