Shell脚本注释如何实现

这篇文章主要介绍了Shell脚本注释如何实现的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇Shell脚本注释如何实现文章都会有所收获，下面我们一起来看看吧。

单行注释

直接在行最前端加上符号 # 即可。具体用法如下所示：

# this is comment test
echo "this is comment test"

多行注释/段注释

一、空命令 : 和追加输入重定向 <<

:<<BLOCK

....注释内容

BLOCK

说明：

• 把输入重定义（<<）到前面的命令，但是 : 是空命令，所以就相当于注释了。

• 这种方法当注释代码里出现变量引用或者是反引号的命令时,shell 会去尝试解析，会提示错误信息，反引号部分不会被注释掉。

例如：

var=`ls -l` # 这个就不会被注释掉，因为有反引号

BLOCK 为 Here Documents 中的定义符号，名称任意，只要前后匹配就行，如下两个例子中分别使用 WORD 和 _a_ 也可以：

例（1）：

:<<WORD

....注释内容

WORD

例（2）：
下面的 :<<_a_ 和 _a_ 代表段注释，可以把中间的代码注释掉，_a_ 为 Here Documents 中的定义符号，名称任意，只要前后匹配就行。

for ((i=0; i<10; i++))
do
:<<_a_    
    if [  ]; then 
        ...
    fi
_a_
    echo ""
done

常用来作为注释的成对字符有：

EOF、_a_、WORD、BLOCK、!

备注：

• EOF 截止符用作后续输入命令

• ! 叹号一般作为嵌入内容部分

• ' 单引号一般用来区分内容

解决注释中有反引号的问题

方法一

:<<BLOCK'
....注释内容
'BLOCK

方法二

:<<'BLOCK
....注释内容
BLOCK'

方法三

:<<'
....注释内容
'

方法四

:<<\EOF
注释的代码...
EOF

方法五

:<<'EOF'
注释的代码...
EOF

二、空命令 : 和 if&hellip;then&hellip; 语句

: 就是什么也不做（do nothing）即空命令，一般用在 if&hellip;then&hellip; 条件中，用作什么也不做的命令，如下：

if [ -d $DIRECTORY ]; then
    :
else
    echo 'the directory do not exit !'
fi

扩展知识：

下面的例（1）是 Here Documents 的用法，意思是将定义符 WORD 传给某脚本或命令。WORD 的内容为两个 WORD 间输入任意内容，这样就可以在脚本中用 cmd 来执行输入而不必再重建一文件。

例（1）：

cmd<<WORD
any input
file content
WORD

Here Documents 常用在菜单屏幕中，看例（2）：
例（2）：

cat <<Menu
1.List
2.Help
3.Exit
Menu

三、空命令 : 和单引号 &rsquo;

注意：单引号 ' 和冒号 : 之间要加空格。

# echo is test
echo "test"
echo "test"
echo "test"
echo "test"
echo "test"  
: '
echo "comment"
echo "comment"
echo "comment"
echo "comment"
echo "comment"
echo "comment"
'

关于“Shell脚本注释如何实现”这篇文章的内容就介绍到这里，感谢各位的阅读！相信大家对“Shell脚本注释如何实现”知识都有一定的了解，大家如果还想学习更多知识，欢迎关注亿速云行业资讯频道。